croutons 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d49c400b14e1ccce5fab8540166dbc4d300df853
-  data.tar.gz: 770ec40bb463b47d65e3db37929b93d3362c68fc
+  metadata.gz: 61e3cdbf4accef61075b07b77c880553dcdf1f16
+  data.tar.gz: 3aa0e45ba9172a432f036be7a3cbfae6741386f8
 SHA512:
-  metadata.gz: 52df3bd704b508230ea387837a433e0047c1db40ca01166da459be7cefc4676912b0fb6ab85cc424b3c3c53f2158ab50445be67206ca0e28b32cc0fe5ccadc2c
-  data.tar.gz: e69654ec8e87815c9c2b8d2cb4472486511eb6c72a81bd7cce9fb9cf01218d69dc55427a76f2a55eaef2e0190e31419a39bf6c2e94a0cdc759dd66f2fa961468
+  metadata.gz: b5fa9c469fa8b4e06de0a863f14b2815f3f5504faf3ef669a7f7f46ab3f2c62a3014c07cab72b55e684a95e867db328f902de03d66701819cba439febb6d971e
+  data.tar.gz: 9f96d24f6d49aa293d4909bfa1d9efb294ea82e7fa925afd59d3ecc55f8266784fe91f0ef9a423cdefced00e7b3df584ad6e4a27f23aa2d6c6765929d2e285e4

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    croutons (0.0.1)
+    croutons (0.0.2)
       rails (>= 4.1.0)
 
 GEM
@@ -91,7 +91,7 @@ GEM
       rspec-mocks (~> 3.0.0)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.3)
-    sprockets (2.12.1)
+    sprockets (2.12.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
@@ -100,6 +100,7 @@ GEM
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (~> 2.8)
+    sqlite3 (1.3.9)
     thor (0.19.1)
     thread_safe (0.3.4)
     tilt (1.4.1)
@@ -118,3 +119,4 @@ DEPENDENCIES
   capybara
   croutons!
   rspec-rails
+  sqlite3

data/README.md

@@ -1,22 +1,105 @@
-# Croutons
+Croutons
+========
 
 Easy breadcrumbs for Rails apps.
 
-## Usage
+Usage
+-----
 
-1. Include `Croutons::Controller` in `ApplicationController`
-2. Call the `#breadcrumbs` helper in your layout or other views
+### Required steps
+
+1. Include `Croutons::Controller` in your `ApplicationController`.
+
+   This will make a `#breadcrumbs` helper available in your layouts and views.
+2. Call the `#breadcrumbs` helper in your layouts or views.
 3. Define a `BreadcrumbTrail` class, which inherits from
-   `Croutons::BreadcrumbTrail`
-4. Define missing methods on the `BreadcrumbTrail` class. For example, for
-   the `admin/locations/index.html.erb` view you would define a
-   `#admin_locations_index` method.
+   `Croutons::BreadcrumbTrail`.
+4. Define missing methods on the `BreadcrumbTrail` class.
+
+   For example, for the `admin/locations/index.html.erb` view you would define
+   an `#admin_locations_index` method.
+
+   In these methods, you build up a breadcrumb trail by calling `#breadcrumb`
+   with a label and an optional URL. You can also call previously defined
+   methods to build on existing trails. View assigns (i.e. the controller
+   instance variables) are available via the `#objects` method which returns a
+   `Hash`. Rails route helpers are also available inside this class.
+
+Please see [the example below](#example) for further reference.
+
+### Optional steps
+
+* Instead of defining a `BreadcrumbTrail` class you can use an object of your
+  own that responds to `#breadcrumbs`.
+
+  To do this, override the private `#breadcrumb_trail` method in the controller
+  where you included `Croutons::Controller`, to return the object you want to
+  use.
+
+  The `#breadcrumbs` method is passed two parameters: one `template_identifier`
+  `String` and one `objects` `Hash`. The `#breadcrumbs` method should return an
+  `Array` of `Croutons::Breadcrumb`s.
+
+* Override the view used to render breadcrumbs.
+
+  To do this, create a view called `breadcrumbs/_breadcrumbs.html.erb`.
+
+  In this view, an `Array` of `Croutons::Breadcrumb`s is assigned to the local
+  variable `breadcrumbs`. These `Croutons::Breadcrumb`s have two public
+  attributes: `#label` and `#url`. The `#url` attribute is optional. To check
+  whether the `Croutons::Breadcrumb` has a `#url` or not (i.e. should be
+  rendered as a link or not), check whether the `#link?` method returns `true`
+  or `false`.
+
+### Example
+
+#### `app/controllers/application_controller.rb`
+
+    class ApplicationController < ActionController::Base
+      include Croutons::Controller
+    end
+
+#### `app/controllers/posts_controller.rb`
+
+    class PostsController < ApplicationController
+      def index
+        @posts = Post.all
+      end
+
+      def show
+        @post = Post.find(params[:id])
+      end
+    end
+
+#### `app/views/layouts/application.html.erb`
+
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>My blog</title>
+      </head>
+      <body>
+        <%= breadcrumbs %>
+        <%= yield %>
+      </body>
+    </html>
+
+#### `app/models/breadcrumb_trail.rb`
+
+    class BreadcrumbTrail < Croutons::BreadcrumbTrail
+      def posts_index
+        breadcrumb("Posts", posts_path)
+      end
 
-    In these methods you build up a breadcrumb trail by calling `#breadcrumb`
-    with a label and an optional URL, and calling the methods for other views
-    to build on existing trails. View assigns (i.e. the controller ivars) are
-    available via the `#objects` method which returns a hash.
+      def posts_show
+        posts_index
+        breadcrumb(objects[:post].title, post_path(objects[:post])
+      end
+    end
 
-## License
+License
+-------
 
-MIT. See the LICENSE file for details.
+Croutons is Copyright © 2014 Calle Erlandsson, George Brocklehurst, and
+thoughtbot. It is free software, and may be redistributed under the terms
+specified in the LICENSE file.

data/croutons.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", ">= 4.1.0"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "capybara"
+  s.add_development_dependency "sqlite3"
 end

data/lib/croutons/controller.rb

@@ -12,10 +12,11 @@ module Croutons
 
     private
 
-    def breadcrumbs
+    def breadcrumbs(objects = {})
       template = lookup_context.find_template(@_template, @_prefixes)
       template_identifier = template.virtual_path.gsub('/', '_')
-      breadcrumbs = breadcrumb_trail.breadcrumbs(template_identifier, view_assigns)
+      objects.reverse_merge!(view_assigns)
+      breadcrumbs = breadcrumb_trail.breadcrumbs(template_identifier, objects)
       render_to_string(
         partial: 'breadcrumbs/breadcrumbs',
         locals: { breadcrumbs: breadcrumbs },

data/lib/croutons/version.rb

@@ -1,3 +1,3 @@
 module Croutons
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/features/breadcrumbs_spec.rb

@@ -5,7 +5,9 @@ describe "Breadcrumbs" do
     setup_rails_app do |rails_app|
       rails_app.scaffold_model "Post", "title:string"
       rails_app.add_croutons_mixin_to_application_controller
-      rails_app.add_breadcrumbs_to_layout
+      rails_app.add_to_view('posts/index', '<%= breadcrumbs %>')
+      rails_app.add_to_view('posts/show', '<%= breadcrumbs role: params[:role] %>')
+      rails_app.add_to_view('posts/new', '<%= breadcrumbs %>')
       rails_app.add_breadcrumb_trail_class <<-RUBY
         require "croutons/breadcrumb_trail"
 
@@ -17,7 +19,9 @@ describe "Breadcrumbs" do
           end
 
           def posts_show
-            posts_index
+            if objects[:role] == "admin"
+              posts_index
+            end
             breadcrumb(objects[:post].title)
           end
         end
@@ -39,7 +43,7 @@ describe "Breadcrumbs" do
       expect(items.first).not_to have_css("a")
     end
 
-    visit post_path(post)
+    visit post_path(post, role: "admin")
 
     with_breadcrumbs do |items|
       expect(items.length).to eq 2
@@ -47,6 +51,14 @@ describe "Breadcrumbs" do
       expect(items.last).to have_content(post.title)
       expect(items.last).not_to have_css("a")
     end
+
+    visit post_path(post, role: "guest")
+
+    with_breadcrumbs do |items|
+      expect(items.length).to eq 1
+      expect(items.first).to have_content(post.title)
+      expect(items.first).not_to have_css("a")
+    end
   end
 
   context "when not defined" do

data/spec/support/rails_app.rb

@@ -19,7 +19,7 @@ class RailsApp
 
   def scaffold_model(name, *columns)
     in_app_directory do
-      run "rails generate scaffold #{name} #{columns.join(' ')} --test-framework=none"
+      run "rails generate scaffold #{name} #{columns.join(' ')} --force"
     end
   end
 
@@ -32,9 +32,9 @@ class RailsApp
     end
   end
 
-  def add_breadcrumbs_to_layout
-    transform_file(path("app/views/layouts/application.html.erb")) do |content|
-      content.sub("<body>", "<body>\n<%= breadcrumbs %>")
+  def add_to_view(name, content_to_add)
+    transform_file(path("app/views/#{name}.html.erb")) do |content|
+      content << content_to_add
     end
   end
 
@@ -45,7 +45,9 @@ class RailsApp
   private
 
   def create_rails_app
-    run "bundle exec rails new #{path} --skip-bundle --force"
+    run "bundle exec rails new #{path} --skip-gemfile --skip-bundle "\
+      "--skip-git --skip-keeps --skip-spring --skip-javascript "\
+      "--skip-test-unit --no-rc --skip-sprockets --force"
   end
 
   def disable_class_caching
@@ -55,7 +57,8 @@ class RailsApp
   end
 
   def customize_gemfile
-    File.open(path("Gemfile"), "a") do |f|
+    File.open(path("Gemfile"), "w") do |f|
+      f << "source 'https://rubygems.org'\n"
       f << "gem 'croutons', path: '#{PROJECT_ROOT}'\n"
       f << "gem 'rspec-rails', group: :test\n"
       f << "gem 'capybara', group: :test\n"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: croutons
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Calle Erlandsson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - calle@thoughtbot.com
@@ -63,6 +77,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE