pankuzu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd63fbf1e51078b1fb136c4c795175f3c00fc669
+  data.tar.gz: daa95dc8c78eea8e1ab24155955c1e88b2575b0c
+SHA512:
+  metadata.gz: 9ae5d4254845fd9420df0cd58e412b6556e0294ec9309104074e3454386a137a4a292e96d470bfdd8f712f7760fc375df5a73948aa030b999815a38be22f978a
+  data.tar.gz: d7c0e1c073ce003137f4349ae13b75670c70f014a9f55aa17a6ea6f395850db8be6cce10ffd2d217fb82aa955014871e5979c2e1e4ee162ae5a09f6960693b14

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Masaki Komagata
+
+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,54 @@
+# Pankuzu
+
+Pankuzu generates breadcrumbs html. (*Pankuzu means bread crumbs in Japanese.*)
+
+## Usage
+
+Put on `breadcrumbs` helper in your view file.
+
+app/views/layouts/application.html.erb:
+```
+<%= render "breadcrumbs" %>
+```
+
+Add breadcrumb each views.
+
+app/views/posts/show.html.erb:
+```
+<%
+add_breadcrumb "Home",          root_path
+add_breadcrumb "Listing Posts", posts_path
+add_breadcrumb "A Post",        post_path(@post)
+%>
+```
+
+`breadcrumbs` helper puts html below.
+
+```html
+<ol class="breadcrumbs">
+  <li class="breadcrumb"><a href="/">Home</a></li>
+  <li class="breadcrumb"><a href="/posts">Listing Posts</a></li>
+  <li class="breadcrumb">A Post</li>
+</ol>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pankuzu"
+```
+
+And then execute:
+```bash
+$ rails genarate pankuzu:install
+```
+
+This generator creates `_breadcrumbs.html.erb` in `app/views/application` directory.
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+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    = 'Pankuzu'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/pankuzu/install_generator.rb

@@ -0,0 +1,14 @@
+require "rails/generators/base"
+
+module Pankuzu
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_initializer_file
+        copy_file "_breadcrumbs.html.erb", "app/views/application/#{file_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/_breadcrumbs.html.erb

@@ -0,0 +1,9 @@
+<% if breadcrumbs.present? %>
+<ol class="breadcrumbs">
+<% breadcrumbs.each do |breadcrumb| %>
+  <li class="breadcrumb">
+    <%= link_to_if breadcrumbs.last != breadcrumb, breadcrumb.name, breadcrumb.url %>
+  </li>
+<% end %>
+</ol>
+<% end %>

data/lib/pankuzu/helper.rb

@@ -0,0 +1,12 @@
+module Pankuzu
+  module Helper
+    def add_breadcrumb(name, url = nil)
+      @_breadcrumbs ||= []
+      @_breadcrumbs << OpenStruct.new(name: name, url: url)
+    end
+
+    def breadcrumbs
+      @_breadcrumbs
+    end
+  end
+end

data/lib/pankuzu/railtie.rb

@@ -0,0 +1,9 @@
+require "pankuzu/helper"
+
+module Pankuzu
+  class Railtie < Rails::Railtie
+    initializer "pankuzu.action_controller_helper" do |_|
+      ActionView::Base.send :include, Pankuzu::Helper
+    end
+  end
+end

data/lib/pankuzu/version.rb

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

data/lib/pankuzu.rb

@@ -0,0 +1,6 @@
+require "pankuzu/version"
+require "pankuzu/helper"
+
+module Pankuzu
+  require "pankuzu/railtie" if defined?(Rails)
+end

data/lib/tasks/pankuzu_tasks.rake

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: pankuzu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masaki Komagata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Generate breadcrumbs simply.
+email:
+- komagata@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/pankuzu/install_generator.rb
+- lib/generators/templates/_breadcrumbs.html.erb
+- lib/pankuzu.rb
+- lib/pankuzu/helper.rb
+- lib/pankuzu/railtie.rb
+- lib/pankuzu/version.rb
+- lib/tasks/pankuzu_tasks.rake
+homepage: https://github.com/komagata/pankuzu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Generate breadcrumbs simply.
+test_files: []