breadcrumble 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. data/.gitignore +17 -0
  2. data/Gemfile +4 -0
  3. data/LICENSE +22 -0
  4. data/README.md +45 -0
  5. data/Rakefile +2 -0
  6. data/app/views/breadcrumble/_breadcrumb.html.erb +8 -0
  7. data/breadcrumble.gemspec +19 -0
  8. data/lib/breadcrumble.rb +10 -0
  9. data/lib/breadcrumble/action_controller.rb +28 -0
  10. data/lib/breadcrumble/action_view.rb +7 -0
  11. data/lib/breadcrumble/engine.rb +4 -0
  12. data/lib/breadcrumble/railtie.rb +13 -0
  13. data/lib/breadcrumble/version.rb +3 -0
  14. data/lib/generators/breadcrumble/views_generator.rb +13 -0
  15. metadata +75 -0
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in breadcrumble.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2012 ma2ge
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,45 @@
1
+ # Breadcrumble
2
+
3
+ Breadcrumble is a simple breadcrumb navigation plugin for Ruby on Rails 3.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'breadcrumble'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install breadcrumble
18
+
19
+ ## Usage
20
+ In your controller, call `add_breadcrumb` to push a new element on the breadcrumb stack.
21
+
22
+ class SampleController
23
+
24
+ add_breadcrumb "home", home_url
25
+ add_breadcrumb "sample", sample_url
26
+
27
+ def index
28
+ add_breadcrumb "index", index_url
29
+ end
30
+
31
+ end
32
+
33
+ In your view, you can render the breadcrumb menu with the `render_breadcrums` helper.
34
+
35
+ <body>
36
+ <%= render_breadcrumbs %>
37
+ </body>
38
+
39
+ ## Contributing
40
+
41
+ 1. Fork it
42
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
43
+ 3. Commit your changes (`git commit -am 'Added some feature'`)
44
+ 4. Push to the branch (`git push origin my-new-feature`)
45
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
data/app/views/breadcrumble/_breadcrumb.html.erb ADDED
@@ -0,0 +1,8 @@
1
+ <div>
2
+ <% breadcrumbs.each_with_index do |crumb, i| %>
3
+ <%= '>' unless i == 0 %>
4
+ <span>
5
+ <%= link_to_unless_current crumb[:name], crumb[:url] %>
6
+ </span>
7
+ <% end %>
8
+ </div>
data/breadcrumble.gemspec ADDED
@@ -0,0 +1,19 @@
1
+ # -*- encoding: utf-8 -*-
2
+ require File.expand_path('../lib/breadcrumble/version', __FILE__)
3
+
4
+ Gem::Specification.new do |gem|
5
+ gem.authors = ["ma2ge"]
6
+ gem.email = ["takayuki.1229@gmail.com"]
7
+ gem.description = "A breadcrumbs plugin for Ruby on Rails 3."
8
+ gem.summary = "Breadcrumble is a simple breadcrumb navigation plugin for Ruby on Rails 3."
9
+ gem.homepage = "https://github.com/ma2gedev/breadcrumble"
10
+
11
+ gem.files = `git ls-files`.split($\)
12
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
13
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
14
+ gem.name = "breadcrumble"
15
+ gem.require_paths = ["lib"]
16
+ gem.version = Breadcrumble::VERSION
17
+
18
+ gem.add_dependency "rails", ['>= 3.0']
19
+ end
data/lib/breadcrumble.rb ADDED
@@ -0,0 +1,10 @@
1
+ require 'rails'
2
+
3
+ require 'breadcrumble/version'
4
+ require 'breadcrumble/action_controller'
5
+ require 'breadcrumble/action_view'
6
+ require 'breadcrumble/railtie'
7
+ require 'breadcrumble/engine'
8
+
9
+ module Breadcrumble
10
+ end
data/lib/breadcrumble/action_controller.rb ADDED
@@ -0,0 +1,28 @@
1
+ module Breadcrumble
2
+ module ActionController
3
+ def self.included(klass)
4
+ klass.extend(ClassMethods)
5
+ klass.helper_method :add_crumb, :breadcrumbs
6
+ end
7
+
8
+ module ClassMethods
9
+ def add_crumb name, url
10
+ before_filter do |controller|
11
+ controller.send :add_crumb, name, url
12
+ end
13
+ end
14
+ end
15
+
16
+ protected
17
+
18
+ def add_crumb(name, url = '')
19
+ @breadcrumbs ||= []
20
+ @breadcrumbs << { name: name, url: url }
21
+ puts @breadcrumbs
22
+ end
23
+
24
+ def breadcrumbs
25
+ @breadcrumbs
26
+ end
27
+ end
28
+ end
data/lib/breadcrumble/action_view.rb ADDED
@@ -0,0 +1,7 @@
1
+ module Breadcrumble
2
+ module ActionView
3
+ def render_breadcrumbs options=nil
4
+ render partial: 'breadcrumble/breadcrumb', locals: options
5
+ end
6
+ end
7
+ end
data/lib/breadcrumble/engine.rb ADDED
@@ -0,0 +1,4 @@
1
+ module Breadcrumble
2
+ class Engine < ::Rails::Engine
3
+ end
4
+ end
data/lib/breadcrumble/railtie.rb ADDED
@@ -0,0 +1,13 @@
1
+ module Breadcrumble
2
+ class Railtie < Rails::Railtie
3
+ initializer "breadcrumble.initialize" do
4
+ ActiveSupport.on_load(:action_controller) do
5
+ include Breadcrumble::ActionController
6
+ end
7
+
8
+ ActiveSupport.on_load(:action_view) do
9
+ include Breadcrumble::ActionView
10
+ end
11
+ end
12
+ end
13
+ end
data/lib/breadcrumble/version.rb ADDED
@@ -0,0 +1,3 @@
1
+ module Breadcrumble
2
+ VERSION = "0.0.1"
3
+ end
data/lib/generators/breadcrumble/views_generator.rb ADDED
@@ -0,0 +1,13 @@
1
+ module Breadcrumble
2
+ module Generators
3
+ class ViewsGenerator < ::Rails::Generators::Base
4
+ source_root File.expand_path('../../../../app/views/breadcrumble', __FILE__)
5
+ desc 'This generator generates breadcrumbs partial template.'
6
+
7
+ def generate_views
8
+ name = '_breadcrumb.html.erb'
9
+ copy_file "#{name}", "app/views/breadcrumble/#{name}"
10
+ end
11
+ end
12
+ end
13
+ end
metadata ADDED
@@ -0,0 +1,75 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: breadcrumble
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - ma2ge
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2012-12-01 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: rails
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '3.0'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: '3.0'
30
+ description: A breadcrumbs plugin for Ruby on Rails 3.
31
+ email:
32
+ - takayuki.1229@gmail.com
33
+ executables: []
34
+ extensions: []
35
+ extra_rdoc_files: []
36
+ files:
37
+ - .gitignore
38
+ - Gemfile
39
+ - LICENSE
40
+ - README.md
41
+ - Rakefile
42
+ - app/views/breadcrumble/_breadcrumb.html.erb
43
+ - breadcrumble.gemspec
44
+ - lib/breadcrumble.rb
45
+ - lib/breadcrumble/action_controller.rb
46
+ - lib/breadcrumble/action_view.rb
47
+ - lib/breadcrumble/engine.rb
48
+ - lib/breadcrumble/railtie.rb
49
+ - lib/breadcrumble/version.rb
50
+ - lib/generators/breadcrumble/views_generator.rb
51
+ homepage: https://github.com/ma2gedev/breadcrumble
52
+ licenses: []
53
+ post_install_message:
54
+ rdoc_options: []
55
+ require_paths:
56
+ - lib
57
+ required_ruby_version: !ruby/object:Gem::Requirement
58
+ none: false
59
+ requirements:
60
+ - - ! '>='
61
+ - !ruby/object:Gem::Version
62
+ version: '0'
63
+ required_rubygems_version: !ruby/object:Gem::Requirement
64
+ none: false
65
+ requirements:
66
+ - - ! '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ requirements: []
70
+ rubyforge_project:
71
+ rubygems_version: 1.8.23
72
+ signing_key:
73
+ specification_version: 3
74
+ summary: Breadcrumble is a simple breadcrumb navigation plugin for Ruby on Rails 3.
75
+ test_files: []