buoys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d580b9e0f703c5a420c2c5e5ae42ef85df820a14
+  data.tar.gz: e3dab0c1686a54587cb32b3305bb46c5b84d8e80
+SHA512:
+  metadata.gz: b9a93ab81d51ada4bf1fe6fcaab14028ca147bf849e1d4f2c07c6470d2e05e1f5ed881812ffeee2dc6f15343c89812b14ca9b25de0af4876dda605401e38abfb
+  data.tar.gz: fe1f9a8aea9f274505df6d2147aea91211d36d96f5929d6b26b0db1e987b53870ddb6c66381eb2a9812b0e83d5a8a81d6cca1dae4d424ba9add2d1f37b997a3a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 muryoimpl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# Buoys
+
+Buoys is a Ruby on Rails breadcrumb plugin like [gretel](https://github.com/lassebunk/gretel).
+
+## Motivation
+
+I like [gretel](https://github.com/lassebunk/gretel) and respect its idea, but I want to create simpler breadcrumb library like [gretel](https://github.com/lassebunk/gretel) using I18n.
+
+## Installation
+
+In your Gemfile
+
+```ruby
+gem 'buoys'
+```
+
+And run:
+
+```ruby
+$ bundle install
+```
+
+## Example
+
+Start by generating configuration and example files.
+```ruby
+$ bin/rails g buoys:install
+  create  config/locale/buoys.en.yml
+  create  app/views/breadcrumbs/_buoys.html.erb
+  create  config/buoys/breadcrumbs.rb
+```
+
+Then, in `config/buoys/breadcrumbs.rb`
+```ruby
+buoy :stories do
+  link 'Stories', stories_path
+end
+
+# 'crumb' is the alias of 'buoy'
+# ex)
+crumb :stories do
+  link 'Stories', stories_path
+end
+
+# link's first argument, it is used as I18n key and defalt value.
+# The key is searched in the scope of 'buoys.breadcrumbs'.
+# ex)
+buoy :story do |story|
+  link :story, story_path(story)
+  # same as `link I18n.t('story', scope: 'buoys.breadcrumbs', default: 'story'), story_path(story)`
+end
+
+# You can alse override Buoys configuration
+# ex)
+buoy :story_tasks do |story|
+  link :story_tasks, story_tasks_path
+  pre_buoy :story, story, {link_current: true}
+end
+
+# You can use 'pre_buoy' as parent. 'parent' is the alias of re_buoy`
+# ex)
+buoy :story_tasks do |story|
+  link :story_tasks, story_tasks_path
+  parent :story, story
+end
+```
+
+Then, set the current buoy(breadcrumb) at the top of view file (like `app/views/stories/index.html.erb`).
+
+```ruby
+<% buoy :stories %>
+```
+
+Then, in `app/views/layouts/application.html.erb`.
+```ruby
+<%= render partial: 'breadcrumbs/buoys' %>
+```
+
+Then, You can build and change breadcrumb  `app/views/breadcrumbs/_buoys.html.erb`
+
+```erb
+<% if buoys.any? %>
+  <ul>
+    <% buoys.each do |link| %>
+      <li>
+        <%# if 'link.current?' is true, link.options includes {class: 'current'}. %>
+        <%= link_to link.url, link.options do %>
+          <span><%= link.text %></span>
+        <% end %>
+        <% if !link.current? %>
+          <span> &gt;</span>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+```  
+
+## Options
+
+| option         | description | default |
+| -------------- | ----------- | ------- |
+| :link_current  | whether current buoy(breadcrumb) should be linked to | false |
+| :current_class | CSS class for current link. if you set `nil`, it is not set CSS class | 'active' |
+
+Copyright (c) 2016 muryoimpl Released under the MIT license

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Buoy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/buoys.rb

@@ -0,0 +1,22 @@
+require 'buoys/version'
+require 'buoys/config'
+require 'buoys/loader'
+require 'buoys/link'
+require 'buoys/buoy'
+require 'buoys/renderer'
+require 'buoys/helper'
+
+module Buoys
+  class << self
+    def buoy_file_paths
+      @buoy_file_paths ||= [
+        Rails.root.join('config', 'buoys', '**', '*.rb')
+      ]
+    end
+
+    def configure
+      yield Buoys::Config
+    end
+  end
+end
+ActionView::Base.send :include, Buoys::Helper

data/lib/buoys/buoy.rb

@@ -0,0 +1,44 @@
+module Buoys
+  class Buoy
+    attr_reader :previous, :context
+    # buoy :account do
+    #   link 'Account', account_path
+    # end
+    #
+    # buoy :account_edit do |account|
+    #   link 'Account Show', show_account_path(account)
+    #   link 'Account Edit', edit_account_path(account)
+    #   pre_buoy :account
+    # end
+    def initialize(context, key, *args)
+      block = Buoys::Loader.buoys[key]
+      raise ArgumentError, "Buoys :#{key} is not found" unless block
+
+      @key, @context = key, context
+      instance_exec *args, &block
+    end
+
+    def link(key, *args)
+      options = args.extract_options!
+      path = args.shift
+      url = path ? context.url_for(path) : path
+
+      text = I18n.t(key, scope: 'buoys.breadcrumbs', default: key)
+
+      links << Buoys::Link.new(text, url, options)
+    end
+
+    def links
+      @links ||= []
+    end
+
+    def pre_buoy(key, *args)
+      @previous = Buoys::Buoy.new(context, key, args)
+    end
+    alias_method :parent, :pre_buoy
+
+    def method_missing(method, *args, &block)
+      context.send(method, *args, &block)
+    end
+  end
+end

data/lib/buoys/config.rb

@@ -0,0 +1,9 @@
+module Buoys
+  class Config
+    class << self
+      attr_accessor :current_class
+
+      attr_accessor :link_current
+    end
+  end
+end

data/lib/buoys/helper.rb

@@ -0,0 +1,31 @@
+module Buoys
+  module Helper
+    # Declare the breadcrumb which want to render in view.
+    #
+    # <%= buoy :help, true %>
+    def buoy(key, *args)
+      @_buoys_renderer = Buoys::Renderer.new(self, key, *args)
+    end
+    alias_method :breadcrumb, :buoy
+
+    # <% buoys.tap do |links| %>
+    #   <% if links.any? %>
+    #     <ul>
+    #       <% links.each do |link| %>
+    #         <li class="<%= link.class %>">
+    #           <%= link_to link.text, link.url %>
+    #         </li>
+    #       <% end %>
+    #     </ul>
+    #   <% end %>
+    # <% end %>
+    def buoys
+      buoys_renderer.render
+    end
+    alias_method :breadcrumbs, :buoys
+
+    def buoys_renderer
+      @_buoys_renderer ||= Buoys::Renderer.new(self, nil)
+    end
+  end
+end

data/lib/buoys/link.rb

@@ -0,0 +1,51 @@
+module Buoys
+  class Link
+    attr_accessor :text, :options, :options_for_config
+    attr_reader :current
+
+    CONFIG = {
+      current_class: (Buoys::Config.current_class || 'active'),
+      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
+      @current = false
+    end
+
+    def mark_as_current!
+      options.merge!(class: config[:current_class])
+      @current = true
+    end
+
+    def current?
+      !!@current
+    end
+
+    def url
+      return '' if current? && !config[:link_current]
+
+      @_url || ''
+    end
+
+    def url=(str)
+      @_url = str
+    end
+
+    private
+
+    def config
+      CONFIG.merge(options_for_config)
+    end
+
+    def extract_options_and_config(_options)
+      options = _options.with_indifferent_access
+      config = (options.keys & CONFIG.keys).each_with_object({}) {|key, hash|
+        hash[key] = options.delete(key)
+      }
+
+      [config, options]
+    end
+  end
+end

data/lib/buoys/loader.rb

@@ -0,0 +1,35 @@
+module Buoys
+  class Loader
+    class << self
+      #
+      # buoy :account do
+      #   link 'Account', account_path
+      # end
+      #
+      # buoy :account_edit do |account|
+      #   link 'Account Edit', edit_account_path(account)
+      #   pre_buoy :account
+      # end
+      def buoy(key, &block)
+        buoys[key] = block
+      end
+      alias_method :crumb, :buoy
+
+      def buoys
+        @buoys ||= {}
+      end
+
+      def load_buoys_files
+        buoys.clear
+
+        buoy_files.each do |file|
+          instance_eval open(file).read, file
+        end
+      end
+
+      def buoy_files
+        Dir[*Buoys.buoy_file_paths]
+      end
+    end
+  end
+end

data/lib/buoys/renderer.rb

@@ -0,0 +1,36 @@
+module Buoys
+  class Renderer
+    def initialize(context, key, *args)
+      @context, @key, @args = context, key, *args
+      Buoys::Loader.load_buoys_files if Buoys::Loader.buoys.keys.empty?
+    end
+
+    def render
+      return [] unless @key
+
+      buoy = Buoys::Buoy.new(@context, @key, @args)
+      build_links(buoy)
+    end
+
+    private
+
+    def build_links(buoy)
+      links = buoy.links.dup
+
+      links.unshift *collect_previous_links(buoy)
+      links.last.mark_as_current!
+
+      links
+    end
+
+    def collect_previous_links(buoy)
+      links = []
+
+      while buoy = buoy.previous
+        links.unshift *buoy.links
+      end
+
+      links
+    end
+  end
+end

data/lib/buoys/version.rb

@@ -0,0 +1,3 @@
+module Buoys
+  VERSION = "0.1.0"
+end

data/lib/generators/buoys/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module Buoys
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    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'
+    end
+  end
+end

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

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

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

@@ -0,0 +1,38 @@
+buoy :example do
+  link :example, 'http://localhost:3000'
+end
+
+# buoy :stories do
+#   link 'Stories', stories_path
+# end
+
+# `crumb` is the alias of `buoy`.
+# ex)
+# crumb :stories do
+#   link 'Stories', stories_path
+# end
+
+# link's first argument, it is used as I18n key and defalt value.
+# The key is searched in the scope of 'buoys.breadcrumbs'.
+#
+# ex)
+# buoy :story do |story|
+#   link :story, story_path(story)
+#   # same as `link I18n.t(:story, scope: 'buoys.breadcrumbs', default: story), story_path(story)`
+# end
+
+# You can alse override Buoys configuration
+#
+# ex)
+# buoy :story_tasks do |story|
+#   link :story_tasks, story_tasks_path
+#   pre_buoy :story, story, {link_current: true}
+# end
+
+# You can use `pre_buoy` as parent. `parent` is the alias of `pre_buoy`
+#
+# ex)
+# buoy :story_tasks do |story|
+#   link :story_tasks, story_tasks_path
+#   parent :story, story
+# end