gretel-trails 0.0.1

data/lib/gretel/trails/strategies/hidden_strategy.rb

@@ -0,0 +1,57 @@
+module Gretel
+  module Trails
+    module HiddenStrategy
+      DEFAULT_JS_SELECTOR = ".js-append-trail"
+      DEFAULT_DATA_ATTRIBUTE = "trail"
+
+      class << self
+        # jQuery selector for links that should have the trail appended
+        # to them on click. Default: +.js-append-trail+
+        def js_selector
+          @js_selector ||= DEFAULT_JS_SELECTOR
+        end
+
+        # Sets the jQuery link selector.
+        attr_writer :js_selector
+
+        # Name of the HTML data attribute that will contain the trail
+        # when it is hidden. Default: +trail+
+        def data_attribute
+          @data_attribute ||= DEFAULT_DATA_ATTRIBUTE
+        end
+
+        # Sets the HTML data attribute.
+        attr_writer :data_attribute
+      end
+    end
+  end
+end
+
+Gretel::Renderer.class_eval do
+  # Moves the trail from the querystring into a data attribute.
+  def link_to_with_hidden_trail(name, url, options = {})
+    if url.include?("#{Gretel.trail_param}=")
+      uri = URI.parse(url)
+      query_hash = Hash[CGI.parse(uri.query.to_s).map { |k, v| [k, v.first] }]
+      trail = query_hash.delete(Gretel.trail_param.to_s)
+
+      options = options.dup
+      options[:data] ||= {}
+      options[:data][Gretel::Trails::HiddenStrategy.data_attribute] = trail
+
+      uri.query = query_hash.to_query.presence
+      url = uri.to_s
+    end
+    link_to_without_hidden_trail(name, url, options)
+  end
+
+  alias_method_chain :link_to, :hidden_trail
+end
+
+ActionView::Base.class_eval do
+  # View helper proxy to the breadcrumb renderer's link_to that automatically
+  # removes trails from URLs and adds them as data attributes.
+  def breadcrumb_link_to(name, url, options = {})
+    gretel_renderer.link_to(name, url, options)
+  end unless method_defined?(:breadcrumb_link_to)
+end

data/lib/gretel/trails/version.rb

@@ -0,0 +1,5 @@
+module Gretel
+  module Trails
+    VERSION = "0.0.1"
+  end
+end

data/lib/gretel/trails.rb

@@ -0,0 +1,25 @@
+require "gretel"
+require "gretel/trails/version"
+require "gretel/trails/engine"
+
+module Gretel
+  module Trails
+    class << self
+      # Activated strategies
+      def strategies
+        @strategies ||= []
+      end
+
+      # Activates strategies. Can be either a symbol or array of symbols.
+      # 
+      #   Gretel::Trails.strategies = :hidden
+      #   Gretel::Trails.strategies = [:hidden, :other_strategy]
+      def strategies=(value)
+        @strategies = [value].flatten
+        @strategies.each { |s| require "gretel/trails/strategies/#{s}_strategy"}
+      end
+
+      alias_method :strategy=, :strategies=
+    end
+  end
+end

data/lib/gretel-trails.rb

@@ -0,0 +1 @@
+require "gretel/trails"

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require gretel.trails.hidden
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/categories_controller.rb

@@ -0,0 +1,5 @@
+class CategoriesController < ApplicationController
+  def show
+    @category = Category.find(params[:id])
+  end
+end

data/test/dummy/app/controllers/products_controller.rb

@@ -0,0 +1,13 @@
+class ProductsController < ApplicationController
+  def show
+    @product = Product.find(params[:id])
+  end
+
+  def reviews
+    @product = Product.find(params[:product_id])
+  end
+
+  def recent
+    @products = Product.order("id DESC")
+  end
+end

data/test/dummy/app/controllers/reviews_controller.rb

@@ -0,0 +1,5 @@
+class ReviewsController < ApplicationController
+  def index
+    @product = Product.find(params[:product_id])
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/category.rb

@@ -0,0 +1,11 @@
+class Category < ActiveRecord::Base
+  has_many :products
+
+  def self.find(*args)
+    find_by_slug(*args) || super
+  end
+
+  def to_param
+    slug
+  end
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,11 @@
+class Product < ActiveRecord::Base
+  belongs_to :category
+
+  def self.find(*args)
+    find_by_slug(*args) || super
+  end
+
+  def to_param
+    slug
+  end
+end

data/test/dummy/app/views/categories/show.html.erb

@@ -0,0 +1,9 @@
+<% breadcrumb :category, @category %>
+
+<h1><%= @category.name %></h1>
+
+<ul id="products">
+  <% @category.products.each do |product| %>
+    <li><%= link_to product.name, product %></li>
+  <% end %>
+</ul>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body data-trail="<%= breadcrumb_trail %>">
+
+<%= breadcrumbs style: :ul %>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/products/recent.html.erb

@@ -0,0 +1,9 @@
+<% breadcrumb :recent_products %>
+
+<h1>Recent Products</h1>
+
+<ul id="products">
+  <% @products.each do |product| %>
+    <li><%= link_to product.name, product, class: "js-append-trail" %></li>
+  <% end %>
+</ul>

data/test/dummy/app/views/products/show.html.erb

@@ -0,0 +1,17 @@
+<% breadcrumb :product, @product %>
+
+<h1><%= @product.name %></h1>
+
+<p>
+  <%= link_to "See reviews", product_reviews_path(@product), class: "js-append-trail" %>
+</p>
+
+<p>
+  The product description would go here.
+</p>
+
+<div id="back">
+  <% parent_breadcrumb do |parent| %>
+    <%= breadcrumb_link_to "Back", parent.url %>
+  <% end %>
+</div>

data/test/dummy/app/views/reviews/index.html.erb

@@ -0,0 +1,13 @@
+<% breadcrumb :product_reviews, @product %>
+
+<h1>Reviews on <%= @product.name %></h1>
+
+<p>
+  No reviews.
+</p>
+
+<div id="back">
+  <% parent_breadcrumb do |parent| %>
+    <%= breadcrumb_link_to "Back", parent.url %>
+  <% end %>
+</div>

data/test/dummy/config/application.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "gretel-trails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/breadcrumbs.rb

@@ -0,0 +1,21 @@
+crumb :root do
+  link "Home", root_path
+end
+
+crumb :category do |category|
+  link category.name, category
+end
+
+crumb :product do |product|
+  link product.name, product
+  parent :category, product.category
+end
+
+crumb :product_reviews do |product|
+  link "Reviews", product_reviews_path(product)
+  parent :product, product
+end
+
+crumb :recent_products do
+  link "Recent products", recent_products_path
+end

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!