buoys 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 328e475c660faef4b8c35b25ffabefcd2097dbb5
-  data.tar.gz: f7aa9ab50d8ead9ffcb2127047c70806438d078e
+  metadata.gz: 3e78176edf374e239e8edc82b58967bd7c8af0db
+  data.tar.gz: 5bc190247b5979b6ceb386efa33e95cbf0b5f963
 SHA512:
-  metadata.gz: 3617a33b4bc75b7c779ccfa00af1eefd394a9293aa651c32b11576c9a008ec312325f30609b1df83d90152440490fc801d15082d9ddd892fd6ea24cf00140e3d
-  data.tar.gz: 31c46adae6c5d0eb145f383f61cdbe69c4866c5e7e61d32a12d0e2a7bb2ae1084a330b15699ce90e0c1e45f95711d94948d2691004bb85877fbbb89d291317c8
+  metadata.gz: 980a48fac48ff04a5926fc8fe7092f99569e84004159114d039c7b65622f59c47fc046ea4ae7ded09c47676781133d08b2c2aceb7d7e29ecffa04a0c994ffa03
+  data.tar.gz: 86540406c985a7c063d056a78a9af5b566c74c7cd0bce44c3296fa963251a4d6974ca1e55d2ccb7977932f00d1c035d1a73507758f598a6cf333b0144862fdaf

data/README.md

@@ -28,8 +28,16 @@ Start by generating configuration and example files.
 ```ruby
 $ bin/rails g buoys:install
   create  config/locale/buoys.en.yml
+  create  config/buoys/breadcrumbs.rb
   create  app/views/breadcrumbs/_buoys.html.erb
+```
+
+You can use `--template haml` and `--template slim` options.
+```ruby
+$ bin/rails g buoys:install --template haml
+  create  config/locale/buoys.en.yml
   create  config/buoys/breadcrumbs.rb
+  create  app/views/breadcrumbs/_buoys.html.haml
 ```
 
 Then, in `config/buoys/breadcrumbs.rb`

data/Rakefile

@@ -14,11 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -30,5 +25,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/lib/buoys/buoy.rb

@@ -14,8 +14,9 @@ module Buoys
       block = Buoys::Loader.buoys[key]
       raise ArgumentError, "Buoys :#{key} is not found" unless block
 
-      @key, @context = key, context
-      instance_exec *args, &block
+      @key = key
+      @context = context
+      instance_exec(*args, &block)
     end
 
     def link(key, *args)
@@ -35,7 +36,7 @@ module Buoys
     def pre_buoy(key, *args)
       @previous = Buoys::Buoy.new(context, key, args)
     end
-    alias_method :parent, :pre_buoy
+    alias parent pre_buoy
 
     def method_missing(method, *args, &block)
       context.send(method, *args, &block)

data/lib/buoys/helper.rb

@@ -6,7 +6,7 @@ module Buoys
     def buoy(key, *args)
       @_buoys_renderer = Buoys::Renderer.new(self, key, *args)
     end
-    alias_method :breadcrumb, :buoy
+    alias breadcrumb buoy
 
     # <% buoys.tap do |links| %>
     #   <% if links.any? %>
@@ -22,7 +22,7 @@ module Buoys
     def buoys
       buoys_renderer.render
     end
-    alias_method :breadcrumbs, :buoys
+    alias breadcrumbs buoys
 
     def buoys_renderer
       @_buoys_renderer ||= Buoys::Renderer.new(self, nil)

data/lib/buoys/link.rb

@@ -5,22 +5,23 @@ module Buoys
 
     CONFIG = {
       current_class: (Buoys::Config.current_class || 'active'),
-      link_current: (Buoys::Config.link_current || false),
+      link_current: (Buoys::Config.link_current || false)
     }.with_indifferent_access
 
     def initialize(text, url, options)
       @options_for_config, @options = extract_options_and_config(options)
-      @text, @_url = text, url
+      @text = text
+      @_url = url
       @current = false
     end
 
     def mark_as_current!
-      options.merge!(class: config[:current_class])
+      options[:class] = config[:current_class]
       @current = true
     end
 
     def current?
-      !!@current
+      @current
     end
 
     def url
@@ -39,8 +40,8 @@ module Buoys
       CONFIG.merge(options_for_config)
     end
 
-    def extract_options_and_config(_options)
-      options = _options.with_indifferent_access
+    def extract_options_and_config(opts)
+      options = opts.with_indifferent_access
       config = (options.keys & CONFIG.keys).each_with_object({}) {|key, hash|
         hash[key] = options.delete(key)
       }

data/lib/buoys/loader.rb

@@ -13,23 +13,37 @@ module Buoys
       def buoy(key, &block)
         buoys[key] = block
       end
-      alias_method :crumb, :buoy
+      alias crumb buoy
 
       def buoys
         @buoys ||= {}
       end
 
+      def loaded_times
+        @loaded_times ||= []
+      end
+
       def load_buoys_files
+        return unless need_reload?
+
         buoys.clear
+        loaded_times.clear
 
         buoy_files.each do |file|
           instance_eval open(file).read, file
+          loaded_times << File.mtime(file)
         end
       end
 
       def buoy_files
         Dir[*Buoys.buoy_file_paths]
       end
+
+      def need_reload?
+        return true if buoys.empty?
+
+        Rails.env.development? && loaded_times != buoy_files.map {|f| File.mtime(f) }
+      end
     end
   end
 end

data/lib/buoys/railtie.rb

@@ -1,6 +1,6 @@
 module Buoys
   class Railtie < ::Rails::Railtie
-    initializer 'buoys' do |_app|
+    initializer 'buoys' do
       ActiveSupport.on_load(:action_view) do
         ActionView::Base.send :include, Buoys::Helper
       end

data/lib/buoys/renderer.rb

@@ -1,11 +1,11 @@
 module Buoys
   class Renderer
     def initialize(context, key, *args)
-      @context, @key, @args = context, key, args
+      @context = context
+      @key = key
+      @args = args
 
-      if Rails.env.development? || Buoys::Loader.buoys.keys.empty?
-        Buoys::Loader.load_buoys_files
-      end
+      Buoys::Loader.load_buoys_files
     end
 
     def render
@@ -20,7 +20,7 @@ module Buoys
     def build_links(buoy)
       links = buoy.links.dup
 
-      links.unshift *collect_previous_links(buoy)
+      links.unshift(*collect_previous_links(buoy))
       links.last.mark_as_current!
 
       links
@@ -29,8 +29,10 @@ module Buoys
     def collect_previous_links(buoy)
       links = []
 
-      while buoy = buoy.previous
-        links.unshift *buoy.links
+      buoy = buoy.previous
+      while buoy
+        links.unshift(*buoy.links)
+        buoy = buoy.previous
       end
 
       links

data/lib/buoys/version.rb

@@ -1,3 +1,3 @@
 module Buoys
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'.freeze
 end

data/lib/generators/buoys/install_generator.rb

@@ -4,10 +4,17 @@ module Buoys
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 
+    class_option :template
+
     def create_files
       copy_file 'buoys.en.yml', 'config/locales/buoys.en.yml'
-      copy_file '_buoys.html.erb', 'app/views/breadcrumbs/_buoys.html.erb'
       copy_file 'breadcrumbs.rb', 'config/buoys/breadcrumbs.rb'
+
+      if %(haml slim).include?(template_type = options[:template])
+        copy_file "_buoys.html.#{template_type}", "app/views/breadcrumbs/_buoys.html.#{template_type}"
+      else
+        copy_file '_buoys.html.erb', 'app/views/breadcrumbs/_buoys.html.erb'
+      end
     end
   end
 end

data/lib/generators/buoys/templates/_buoys.html.haml

@@ -0,0 +1,9 @@
+- if buoys.any?
+  %ol.breadcrumb
+    - buoys.each do |link|
+      %li
+        - # if `link.current?` is true, link.options includes {class: 'current'}.
+        - if link.current?
+          %span= link.text
+        - else
+          = link_to link.text, link.url, link.options

data/lib/generators/buoys/templates/_buoys.html.slim

@@ -0,0 +1,10 @@
+- if buoys.any?
+  ol.breadcrumb
+    - buoys.each do |link|
+      li
+        - # if `link.current?` is true, link.options includes {class: 'current'}.
+        - if link.current?
+          span
+            = link.text
+        - else
+          = link_to link.text, link.url, link.options

data/test/buoys_helper_test.rb

@@ -9,35 +9,99 @@ class BuoysHelerTest < ActionView::TestCase
     buoy :account
     html = render('breadcrumbs/buoys').gsub(/[[:space:]]{2,}|\n/, '')
 
-    assert_dom_equal %{<ul><li><a class="active" href=""><span>Account</span></a></li></ul>}, html
+    assert_dom_equal %(<ul><li><a class="active" href=""><span>Account</span></a></li></ul>), html
   end
 
   test '.buoy (not only active)' do
     buoy :history
     html = render('breadcrumbs/buoys').gsub(/[[:space:]]{2,}|\n/, '')
+    expected_html =
+      %(
+        <ul>
+          <li>
+            <a class="hover" href="/about">
+              <span>about</span>
+            </a>
+            <span>&gt;</span>
+          </li>
+          <li>
+            <a class="active" href="">
+              <span>history</span>
+            </a>
+          </li>
+        </ul>
+      ).gsub(/[[:space:]]{2,}|\n/, '')
 
-    assert_dom_equal %{<ul><li><a class="hover" href="/about"><span>about</span></a><span>&gt;</span></li><li><a class="active" href=""><span>history</span></a></li></ul>}, html
+    assert_dom_equal expected_html, html
   end
 
   test '.buoy (has 2 `link`s in one buoy block)' do
     breadcrumb :help, true
     html = render('breadcrumbs/buoys').gsub(/[[:space:]]{2,}|\n/, '')
+    expected_html =
+      %(
+        <ul>
+          <li>
+            <a class="hover" href="https://example.com/help">
+              <span>help</span>
+            </a>
+            <span>&gt;</span>
+          </li>
+          <li>
+            <a class="active" href="">
+              <span>usage</span>
+            </a>
+          </li>
+        </ul>
+      ).gsub(/[[:space:]]{2,}|\n/, '')
 
-    assert_dom_equal %{<ul><li><a class="hover" href="https://example.com/help"><span>help</span></a><span>&gt;</span></li><li><a class="active" href=""><span>usage</span></a></li></ul>}, html
+    assert_dom_equal expected_html, html
   end
 
   test '.buoy (receive multiple arguments)' do
     breadcrumb :edit_book_author, 1, 2
     html = render('breadcrumbs/buoys').gsub(/[[:space:]]{2,}|\n/, '')
+    expected_html =
+      %(
+        <ul>
+          <li>
+            <a class="hover" href="http://example.com/books">
+              <span>Books</span>
+            </a>
+            <span>&gt;</span>
+          </li>
+          <li>
+            <a class="active" href="http://example.com/books/1/authors/2">
+              <span>edit-1-2</span>
+            </a>
+          </li>
+        </ul>
+      ).gsub(/[[:space:]]{2,}|\n/, '')
 
-    assert_dom_equal %{<ul><li><a class="hover" href="http://example.com/books"><span>Books</span></a><span>&gt;</span></li><li><a class="active" href="http://example.com/books/1/authors/2"><span>edit-1-2</span></a></li></ul>}, html
+    assert_dom_equal expected_html, html
   end
 
   test ".buoy (has configuration options in link's arguments)" do
     breadcrumb :show_books, 1
     html = render('breadcrumbs/buoys').gsub(/[[:space:]]{2,}|\n/, '')
+    expected_html =
+      %(
+        <ul>
+          <li>
+            <a class="hover" href="http://example.com/books">
+              <span>Books</span>
+            </a>
+            <span>&gt;</span>
+          </li>
+          <li>
+            <a class="active" href="http://example.com/books/1">
+              <span>show-1</span>
+            </a>
+          </li>
+        </ul>
+      ).gsub(/[[:space:]]{2,}|\n/, '')
 
-    assert_dom_equal %{<ul><li><a class="hover" href="http://example.com/books"><span>Books</span></a><span>&gt;</span></li><li><a class="active" href="http://example.com/books/1"><span>show-1</span></a></li></ul>}, html
+    assert_dom_equal expected_html, html
   end
 
   test '.buoys (no given key)' do

data/test/buoys_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class BuoysTest < ActiveSupport::TestCase
-  test ".buoy_file_paths" do
+  test '.buoy_file_paths' do
     assert_equal [Rails.root.join('config', 'buoys', '**', '*.rb')], Buoys.buoy_file_paths
   end
 end

data/test/test_helper.rb

@@ -1,20 +1,22 @@
 # Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
-ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
-require "rails/test_help"
+require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../../test/dummy/db/migrate', __FILE__)]
+require 'rails/test_help'
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.
 Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each do |f|
+  require f
+end
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.respond_to?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixture_path = File.expand_path('../fixtures', __FILE__)
   ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
   ActiveSupport::TestCase.fixtures :all
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buoys
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - muryoimpl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deka_eiwakun
+  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: A Ruby on Rails breadcrumbs plugin.
 email:
 - muryoimpl@gmail.com
@@ -73,9 +87,10 @@ files:
 - lib/buoys/version.rb
 - lib/generators/buoys/install_generator.rb
 - lib/generators/buoys/templates/_buoys.html.erb
+- lib/generators/buoys/templates/_buoys.html.haml
+- lib/generators/buoys/templates/_buoys.html.slim
 - lib/generators/buoys/templates/breadcrumbs.rb
 - lib/generators/buoys/templates/buoys.en.yml
-- lib/tasks/buoy_tasks.rake
 - test/buoys_buoy_test.rb
 - test/buoys_helper_test.rb
 - test/buoys_loader_test.rb

data/lib/tasks/buoy_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :buoy do
-#   # Task goes here
-# end