gretel-lite 3.0.10

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/gemfiles/Gemfile-rails.3.1.x

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gem "gretel",  :path => ".."
+
+gem "rails", "~> 3.1.0"
+gem "sqlite3"
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'test-unit', '~> 3.0' if RUBY_VERSION >= "2.2"

data/gemfiles/Gemfile-rails.3.2.x

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gem "gretel",  :path => ".."
+
+gem "rails", "~> 3.2.0"
+gem "sqlite3"
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'test-unit', '~> 3.0' if RUBY_VERSION >= "2.2"

data/gemfiles/Gemfile-rails.4.0.x

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gem "gretel",  :path => ".."
+
+gem "rails", "~> 4.0.0"
+gem "sqlite3"
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'test-unit', '~> 3.0' if RUBY_VERSION >= "2.2"

data/gemfiles/Gemfile-rails.4.1.x

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gem "gretel",  :path => ".."
+
+gem "rails", "~> 4.1.0"
+gem "sqlite3"
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'test-unit', '~> 3.0' if RUBY_VERSION >= "2.2"

data/gretel.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gretel/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gretel-lite"
+  gem.version       = Gretel::VERSION
+  gem.authors       = ["Lasse Bunk", "Aleksander Sumowski"]
+  gem.email         = ["lassebunk@gmail.com", "j@sumowski.pl"]
+  gem.description   = %q{Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs.}
+  gem.summary       = %q{Flexible Ruby on Rails breadcrumbs plugin.}
+  gem.homepage      = "http://github.com/aleksandersumowski/gretel"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport", ">= 3.1.0"
+  gem.add_dependency "railties", ">= 3.1.0"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/generators/gretel/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates a sample breadcrumbs configuration file for Gretel.
+
+Example:
+  rails generate gretel:install
+
+  This will create:
+    config/breadcrumbs.rb

data/lib/generators/gretel/install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+module Gretel
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    desc "Creates a sample configuration file in config/breadcrumbs.rb"
+    def create_config_file
+      copy_file "breadcrumbs.rb", "config/breadcrumbs.rb"
+    end
+  end
+end

data/lib/generators/gretel/templates/breadcrumbs.rb

@@ -0,0 +1,28 @@
+crumb :root do
+  link "Home", root_path
+end
+
+# crumb :projects do
+#   link "Projects", projects_path
+# end
+
+# crumb :project do |project|
+#   link project.name, project_path(project)
+#   parent :projects
+# end
+
+# crumb :project_issues do |project|
+#   link "Issues", project_issues_path(project)
+#   parent :project, project
+# end
+
+# crumb :issue do |issue|
+#   link issue.title, issue_path(issue)
+#   parent :project_issues, issue.project
+# end
+
+# If you want to split your breadcrumbs configuration over multiple files, you
+# can create a folder named `config/breadcrumbs` and put your configuration
+# files there. All *.rb files (e.g. `frontend.rb` or `products.rb`) in that
+# folder are loaded and reloaded automatically when you change them, just like
+# this file (`config/breadcrumbs.rb`).

data/lib/gretel.rb

@@ -0,0 +1,82 @@
+require 'gretel/version'
+require 'gretel/resettable'
+require 'gretel/crumbs'
+require 'gretel/crumb'
+require 'gretel/link'
+require 'gretel/renderer'
+require 'gretel/view_helpers'
+require 'gretel/deprecated'
+
+module Gretel
+  class << self
+    include Resettable
+
+    # Returns the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+
+    # in the app and all loaded engines. Breadcrumbs set in the app will override
+    # breadcrumbs set in engines.
+    def breadcrumb_paths
+      @breadcrumb_paths ||= begin
+        engines = Rails::Engine::Railties.respond_to?(:engines) ?
+          Rails::Engine::Railties.engines :
+          Rails::Engine.subclasses.map(&:instance)
+
+        engine_roots = engines.map { |e| e.config.root }
+        
+        [*engine_roots, Rails.root].map do |root|
+          [root.join("config", "breadcrumbs.rb"),
+           root.join("config", "breadcrumbs", "**", "*.rb"),
+           root.join("app", "views", "breadcrumbs", "**", "*.rb")]
+        end.flatten
+      end
+    end
+
+    # Sets the path from with breadcrumbs are loaded. Default is +config/breadcrumbs.rb+.
+    def breadcrumb_paths=(paths)
+      @breadcrumb_paths = paths
+    end
+
+    # Whether to suppress deprecation warnings.
+    def suppress_deprecation_warnings?
+      !!@suppress_deprecation_warnings
+    end
+
+    # Sets whether to suppress deprecation warnings.
+    def suppress_deprecation_warnings=(value)
+      @suppress_deprecation_warnings = value
+    end
+
+    # Shows a deprecation warning.
+    def show_deprecation_warning(message)
+      return if suppress_deprecation_warnings?
+      message = "[Gretel] #{message}"
+      puts message
+      Rails.logger.warn message
+    end
+
+    # Array of Rails environment names with automatic configuration reload. Default is +["development"]+.
+    def reload_environments
+      @reload_environments ||= ["development"]
+    end
+
+    # Registers a style for later use.
+    # 
+    #   Gretel.register_style :ul, { container_tag: :ul, fragment_tag: :li }
+    def register_style(style, options)
+      Gretel::Renderer.register_style style, options
+    end
+
+    # Sets the Rails environment names with automatic configuration reload. Default is +["development"]+.
+    attr_writer :reload_environments
+
+    # Yields this +Gretel+ to be configured.
+    # 
+    #   Gretel.configure do |config|
+    #     config.reload_environments << "staging"
+    #   end
+    def configure
+      yield self
+    end
+  end
+end
+
+ActionView::Base.send :include, Gretel::ViewHelpers

data/lib/gretel/crumb.rb

@@ -0,0 +1,68 @@
+module Gretel
+  class Crumb
+    # Initializes a new crumb from the given +key+.
+    # It finds the breadcrumb created in +Gretel::Crumbs.layout+ and renders the block using the arguments supplied in +args+.
+    def initialize(context, key, *args)
+      if key.class.respond_to?(:model_name)
+        # Enables calling `breadcrumb @product` instead of `breadcrumb :product, @product`
+        args.unshift key
+        key = key.class.model_name.to_s.underscore.to_sym
+      end
+
+      block = Gretel::Crumbs.crumbs[key]
+      raise ArgumentError, "Breadcrumb :#{key} not found." unless block
+      @key = key
+      @context = context
+      instance_exec *args, &block
+    end
+
+    # Sets link of the breadcrumb.
+    # You can supply an optional options hash that will be available on the links
+    # so you can pass info when rendering the breadcrumbs manually.
+    #
+    #   link "My Link", my_link_path
+    #   link "Without URL"
+    #   link "With Options", my_path, title: "Test", other: "Some other value"
+    def link(*args)
+      options = args.extract_options!
+      text, url = args
+
+      # Transform objects to real paths.
+      url = url_for(url) if url
+      
+      links << Gretel::Link.new(key, text, url, options)
+    end
+
+    # Holds all of the breadcrumb's links as a breadcrumb can have multiple links.
+    def links
+      @links ||= []
+    end
+
+    # Sets or gets the parent breadcrumb.
+    # If you supply a parent key and optional arguments, it will set the parent.
+    # If nothing is supplied, it will return the parent, if this has been set.
+    #
+    # Example:
+    #   parent :category, category
+    #
+    # Or short, which will infer the key from the model's `model_name`:
+    #   parent category
+    def parent(*args)
+      return @parent if args.empty?
+      key = args.shift
+
+      @parent = Gretel::Crumb.new(context, key, *args)
+    end
+
+    # Key of the breadcrumb.
+    attr_reader :key
+
+    # The current view context.
+    attr_reader :context
+
+    # Proxy to view context.
+    def method_missing(method, *args, &block)
+      context.send(method, *args, &block)
+    end
+  end
+end

data/lib/gretel/crumbs.rb

@@ -0,0 +1,64 @@
+module Gretel
+  module Crumbs
+    class << self
+      include Resettable
+
+      # Stores the supplied block for later use.
+      def crumb(key, &block)
+        crumbs[key] = block
+      end
+
+      # Returns a hash of all stored crumb blocks.
+      def crumbs
+        @crumbs ||= {}
+      end
+
+      # Returns true if a crumb with the given key has been set.
+      def crumb_defined?(key)
+        crumbs.has_key?(key)
+      end
+
+      # Loads the breadcrumb configuration files.
+      def load_breadcrumbs
+        @crumbs = {}
+
+        loaded_file_mtimes.clear
+        breadcrumb_files.each do |file|
+          instance_eval open(file).read, file
+          loaded_file_mtimes << File.mtime(file)
+        end
+
+        @loaded = true
+      end
+
+      # Reloads the breadcrumb configuration files if they have changed.
+      def reload_if_needed
+        load_breadcrumbs if reload?
+      end
+
+      # Returns true if a breadcrumbs reload is needed based on configuration file changes.
+      def reload?
+        return true unless loaded?
+        return false unless Gretel.reload_environments.include?(Rails.env)
+
+        loaded_file_mtimes != breadcrumb_files.map { |file| File.mtime(file) }
+      end
+
+      # Returns true if the breadcrumb configuration files have been loaded.
+      def loaded?
+        !!@loaded
+      end
+
+      # List of breadcrumb configuration files.
+      def breadcrumb_files
+        Dir[*Gretel.breadcrumb_paths]
+      end
+
+    private
+
+      def loaded_file_mtimes
+        @loaded_file_mtimes ||= []
+      end
+    end
+  end
+end

data/lib/gretel/deprecated.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/deprecated/*.rb"].each { |file| require file }

data/lib/gretel/deprecated/default_style_key.rb

@@ -0,0 +1,25 @@
+if RUBY_VERSION < "2.0"
+  Gretel::Renderer.class_eval do
+    def options_for_style_with_default_style_key(style_key)
+      if style_key == :default
+        Gretel.show_deprecation_warning "The :default style key is now called :inline. Please use `breadcrumbs style: :inline` instead or omit it, as it is the default."
+        style_key = :inline
+      end
+      options_for_style_without_default_style_key(style_key)
+    end
+
+    alias_method_chain :options_for_style, :default_style_key
+  end
+else
+  module DeprecatedDefaultStyleKey
+    def options_for_style(style_key)
+      if style_key == :default
+        Gretel.show_deprecation_warning "The :default style key is now called :inline. Please use `breadcrumbs style: :inline` instead or omit it, as it is the default."
+        style_key = :inline
+      end
+      super(style_key)
+    end
+  end
+
+  Gretel::Renderer.send :prepend, DeprecatedDefaultStyleKey
+end

data/lib/gretel/deprecated/layout.rb

@@ -0,0 +1,15 @@
+Gretel::Crumbs.class_eval do
+  class << self
+    # Was used to lay out breadcrumbs in an initializer. Deprecated since v2.1.0
+    # and removed in v3.0.0. Will raise an exception if used. Put breadcrumbs in
+    # +config/breadcrumbs.rb+ instead (see
+    # https://github.com/lassebunk/gretel/blob/master/README.md for details).
+    def layout(&block)
+      raise (
+        "Gretel::Crumbs.layout was removed in Gretel version 3.0. " +
+        "Please put your breadcrumbs in `config/breadcrumbs.rb`. " +
+        "This will also automatically reload your breadcrumbs when you change them in the development environment. " +
+        "See https://github.com/lassebunk/gretel/blob/master/README.md for details.")
+    end
+  end
+end

data/lib/gretel/deprecated/show_root_alone.rb

@@ -0,0 +1,27 @@
+if RUBY_VERSION < "2.0"
+  Gretel::Renderer.class_eval do
+    def options_for_render_with_show_root_alone(options = {})
+      options = options_for_render_without_show_root_alone(options)
+      if show_root_alone = options.delete(:show_root_alone)
+        Gretel.show_deprecation_warning "The :show_root_alone option is deprecated and will be removed in Gretel v4.0.0. Use `breadcrumbs(display_single_fragment: #{show_root_alone.inspect})` instead."
+        options[:display_single_fragment] = show_root_alone
+      end
+      options
+    end
+
+    alias_method_chain :options_for_render, :show_root_alone
+  end
+else
+  module DeprecatedShowRootAlone
+    def options_for_render(options = {})
+      options = super(options)
+      if show_root_alone = options.delete(:show_root_alone)
+        Gretel.show_deprecation_warning "The :show_root_alone option is deprecated and will be removed in Gretel v4.0.0. Use `breadcrumbs(display_single_fragment: #{show_root_alone.inspect})` instead."
+        options[:display_single_fragment] = show_root_alone
+      end
+      options
+    end
+  end
+
+  Gretel::Renderer.send :prepend, DeprecatedShowRootAlone
+end