Merge branch 'publify_debugging_lab'

Author: nathanallen

Gemfile

@@ -83,6 +83,7 @@ group :development, :test do
   gem 'rspec-rails', '~> 3.4.0'
   gem 'simplecov', require: false
   gem 'pry-rails'
+  gem 'ffaker'
 end
 
 group :development do

README.md

@@ -1,18 +1,11 @@
-# Publify
+# Rails Legacy App
 
-**The Ruby on Rails publishing software formerly known as Typo**
+In this lab you will dive into a mature rails application and attempt to fix some reported bugs. This lab will stretch your debugging skills and your ability to navigate a large rails project. We encourage you to tackle it in pairs.
 
-### Download
+> This Rails application has been intentionally broken!
 
-You can download the latest
-Publify [stable release (8.2.0)](https://github.com/publify/publify/archive/v8.2.0.tar.gz)
-or [clone the Publify repository](https://github.com/publify/publify.git).
-
-[![Build Status](https://travis-ci.org/publify/publify.png?branch=master)](https://travis-ci.org/publify/publify)
-[![Code Climate](https://codeclimate.com/github/publify/publify.png)](https://codeclimate.com/github/publify/publify)
-[![Dependency Status](https://gemnasium.com/publify/publify.png)](https://gemnasium.com/publify/publify)
-
-## What's Publify?
+### What's Publify?
+You will be forking & cloning an open source (MIT LICENSE) blogging platform called Publify.
 
 Publify is a simple but full featured web publishing software. It's built
 around a blogging engine and a small message system connected to Twitter.
@@ -23,7 +16,11 @@ site, and Publish On your Own Site, Syndicate Everywhere.
 Publify has been around since 2004 and is the oldest Ruby on Rails open source
 project alive.
 
-## Features
+[![Build Status](https://travis-ci.org/publify/publify.png?branch=master)](https://travis-ci.org/publify/publify)
+[![Code Climate](https://codeclimate.com/github/publify/publify.png)](https://codeclimate.com/github/publify/publify)
+[![Dependency Status](https://gemnasium.com/publify/publify.png)](https://gemnasium.com/publify/publify)
+
+#### Features
 
 - A classic multi user blogging engine
 - Short messages with a Twitter connection
@@ -35,126 +32,93 @@ project alive.
   German, Danish, Norwegian, Japanese, Hebrew, Simplified Chinese, Mexican
   Spanish, Italian, Lithuanian, Dutch, Polish, Romanian…
 
-## Demo site
-
-You can [give Publify a try](http://demo.publify.co)
-
-The login / password [to the admin](http://demo.publify.co/admin)
-are:
+#### Resources
 
-- Administrator: admin / admin
-- Publisher: publish / publish
-
-The demo is reset every 2 hours.
+- [Publify Repo](https://github.com/publify/publify/issues)
+- [Publify blog](http://blog.publify.co)
+- [Publify on Twitter](https://twitter.com/getpublify)
+- IRC: \#publify on irc.freenode.net
 
-## Install Publify  locally
+## Getting Started: Installing Publify Locally
 
 To install Publify you need the following:
 
 - Ruby 2.0, 2.1 or 2.2
 - Ruby On Rails 4.2.0
 - A database engine, MySQL, PgSQL or SQLite3
+
 - A compatible JavaScript installation for asset compilation. See [the execjs
   readme](https://github.com/sstephenson/execjs#readme) for details.
-- ImageMagick (used by mini_magick).
+- ImageMagick
 
-1.  Unzip Publify archive
-2.  Rename database.yml.yourEngine as database.yml
-3.  Edit database.yml to add your database name, login and password.
+#### Setup ImageMagick Dependency
+Make sure that you have ImageMagick installed (used by mini_magick).
 
+Check for imagemagick:
 ```bash
-$ bundle install
-$ rake db:setup
-$ rake db:migrate
-$ rake db:seed
-$ rake assets:precompile
-$ rails server
-```
-
-You can now launch you browser and access 127.0.0.1:3000.
-
-## Install Publify on Heroku
-
-In order to install Publify on Heroku, you’ll need to do some minor tweaks.
-
-### Storage
-
-You need to setup Amazon S3 storage to be able to upload files on your
-blog. Set Heroku config vars.
-
-```yaml
-heroku config:set provider=AWS
-aws_access_key_id=YOUR_AWS_ACCESS_KEY_ID
-aws_secret_access_key=YOUR_AWS_SECRET_ACCESS_KEY
-aws_bucket=YOUR_AWS_BUCKET_NAME
+$ which convert
+# /path/to/bin/convert
 ```
 
-To generate the Gemfile.lock, run:
+Install it if it's missing (this can take a few minutes):
 ```bash
-HEROKU=true bundle install
+$ brew update
+$ brew link
+$ brew install imagemagick
 ```
 
-Remove Gemfile.lock from .gitignore and commit it.
-
-Add the HEROKU config variable to your Heroku instance:
+#### Setup Rails Application
+Fork & Clone the Publify repo:
 
 ```bash
-heroku config:set HEROKU=true
+$ bundle install
+$ rake db:setup
+$ rake db:migrate
+$ rails server
 ```
 
-Push the repository to Heroku.
-
-When deploying for the first time, Heroku will automatically add a Database
-plugin to your instance and links it to the application. After the first
-deployment, don't forget to run the database migration and seed.
+You can now launch you browser and access 127.0.0.1:3000.
 
-```bash
-heroku run rake db:migrate db:seed
-```
+You will be prompted to supply a blog title and email:
 
-If application error has occurred after migration, you need to restart Heroku server.
+You will be signed in and issued a username and password:
 
+#### Seed your blog with posts & tags
 ```bash
-heroku restart
+$ rake db:seed
+# => Seeded 24 articles...
 ```
 
-## Resources
-
-- [Sidebar Plugins](https://github.com/publify/publify/wiki/Sidebar-plugins)
-- [In page Plugins](https://github.com/publify/publify/wiki/In-Page-Plugins)
-- [**Report a bug**](https://github.com/publify/publify/issues)
-- [**Frequently Asked Questions**](https://github.com/publify/publify/wiki/frequently-asked-questions)
-- [Publify blog](http://blog.publify.co)
-- [Publify on Twitter](https://twitter.com/getpublify)
-- IRC: \#publify on irc.freenode.net
-
-### Maintainers
+#### Look around!
+* Go to the `/admin` backend and poke around (it's similar to wordpress).
+* Create your first blog post!
 
-This is a list of Publify maintainers. If you have committed, please add
-your name and contact details to the list.
+##The Bugs
+The following issues have been added to the main github repo. Please fix each bug on its own branch (e.g. `fix_sidebar_styles`). When you're finished, create a pull request from your fork back to the main repo.
 
-**Frédéric de Villamil** <[email protected]>
-blog: http://t37.net
-irc: neuro`
+> Make sure to reference the issue you are resolving!
 
-**Matijs van Zuijlen**
-blog: http://www.matijs.net/blog/
-irc: matijs
+####Issue \#1: Inconsistent Sidebar Styles
+* All titles in the sidebar should have `monospace` style font
+* All bullets should be circles.
 
-**Thomas Lecavelier**
-blog: http://blog.ookook.fr/
-irc: ook
+<img width="221" alt="sidebar styles" src="https://cloud.githubusercontent.com/assets/1489337/12761855/80fe8e7c-c9a1-11e5-9070-6113b8e9b419.png">
 
-**Yannick François**
-blog: http://elsif.fr
-irc: yaf
+####Issue \#2: Top Month Always Empty (Archive Sidebar)
+* When I click on the top-most month in the Archive Sidebar it says "No posts found...".
+* When I create a post in the _current month_ (e.g. February) it displays a link in the sidebar for _next month_ (e.g. March), and says "No posts found..."
 
-And [many more cool people who’ve one day or another contributed to
-Publify](https://github.com/publify/publify/graphs/contributors).
+####Issue \#3: Months sorted incorrectly (Archive Sidebar)
+The sort order of months in the Archive Sidebar is off, with January 2015 appearing directly above December 2015:
 
-**Original Author: Tobias Luetke**
-blog: http://blog.leetsoft.com/
-irc: xal
+<img width="249" alt="archive sidebar sort order" src="https://cloud.githubusercontent.com/assets/1489337/12761829/698e56fa-c9a1-11e5-8d90-04ed28aa7a09.png">
 
-Enjoy,
-The Publify team
+## Helpful Hints
+* Use **Rubber Duck Debugging** -- Make sure you understand the issue!
+* Use frequent **Sanity Checks**
+    - What are you testing / what are you expecting?
+* **Follow the trail**
+    - How do you work backwards from the view to the server?
+    - How do you find specific files in your rails application?
+    - How do you find specific keywords or method calls?
+* Sometimes you need to **resart the server** if the views you are working with are being cached.

app/assets/stylesheets/user-styles.css

@@ -24,6 +24,14 @@ img.right {
 }
 
 .status {
-  background: #fff; 
+  background: #fff;
   margin: -8px; padding: 8px;
-}
+}
+
+#sidebar .sidebar-title {
+  font-family: monospace;
+}
+
+#sidebar .sidebar-body li {
+  list-style-type: circle;
+}

app/controllers/setup_controller.rb

@@ -52,7 +52,7 @@ def update_or_create_first_post_with_user(user)
                                 allow_pings: 1,
                                 published: 1,
                                 permalink: 'hello-world',
-                                tags: [Tag.first],
+                                tags: [Tag.create(name: 'general', display_name: 'General')],
                                 user: user)
     end
   end

db/seeds.rb

@@ -6,9 +6,8 @@
 #   cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
 #   Mayor.create(name: 'Daley', city: cities.first)
 
-blog = Blog.first || Blog.create!
 
-tag = blog.tags.first || Tag.create!(name: 'general', display_name: 'General', blog_id: blog.id)
+blog = Blog.first || Blog.create!
 
 unless blog.sidebars.any?
   PageSidebar.create!(active_position: 0, staged_position: 0, blog_id: blog.id)
@@ -46,3 +45,28 @@
 unless File.directory?("#{::Rails.root.to_s}/public/files")
   Dir.mkdir("#{::Rails.root.to_s}/public/files")
 end
+
+#### Seed Fake Blog Posts
+if User.first # ensures publify was setup & admin created
+
+  seed_date = Date.today
+  seed_tags = ["happy", "coding", "debugging", "pry", "grep", "wdi", "legacy code"]
+  article_qty = 24
+  user = User.first
+
+  Blog.first.articles.destroy_all
+  article_qty.times do
+    blog.articles.create do |article|
+      article.title = FFaker::Company.catch_phrase
+      article.body = FFaker::HipsterIpsum.paragraph(rand(1..3))
+      seed_date -= 30
+      article.published_at = seed_date
+      article.published = true
+      article.user = user
+      article.keywords = seed_tags.sample(rand(1..4)).join(",")
+    end
+  end
+
+  p "Seeded #{article_qty} articles"
+
+end

lib/archives_sidebar/app/views/archives_sidebar/_content.html.erb

@@ -1,11 +1,11 @@
 <% unless sidebar.archives.blank? %>
-  <h3 class="sidebar-title"><%= sidebar.title %></h3>
-  <div class="sidebar-body">
+  <h3 class="sidebar_title"><%= sidebar.title %></h3>
+  <div class="sidebar_body">
     <ul id="archives">
       <% sidebar.archives.each do |month| %>
         <% counter = sidebar.show_count ? "<em>(#{month[:article_count]})</em>" : "" %>
         <li>
-          <%= link_to"#{month[:name]} #{counter}".html_safe,  articles_by_month_path(month[:year], "%02i" % month[:month]) %>
+          <%= link_to"#{month[:name]} #{counter}".html_safe,  articles_by_month_path( month[:year], "%02i" % (month[:month]+1) ) %>
         </li>
       <% end %>
     </ul>

lib/archives_sidebar/lib/archives_sidebar.rb

@@ -2,7 +2,7 @@ class ArchivesSidebar < Sidebar
   description 'Displays links to monthly archives'
   setting :title, 'Archives'
   setting :show_count, true, label: 'Show article counts', input_type: :checkbox
-  setting :count, 10, label: 'Number of Months'
+  setting :count, 12, label: 'Number of Months'
 
   attr_accessor :archives
 
@@ -30,11 +30,11 @@ def parse_request(_contents, _params)
     article_counts = Content.find_by_sql(["select count(*) as count, #{date_func} from contents where type='Article' and published = ? and published_at < ? group by year,month order by year desc,month desc limit ? ", true, Time.now, count.to_i])
 
     @archives = article_counts.map do |entry|
-      month = entry.month.to_i
+      month = (entry.month.to_i%12)+1
       year = entry.year.to_i
       {
         name: I18n.l(Date.new(year, month), format: '%B %Y'),
-        month: month,
+        month: month - 1,
         year: year,
         article_count: entry.count
       }