panko 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d21ecbe2bf40f8bb5f6c8c1e414d771acc71224
+  data.tar.gz: 3dff0b7e16bdcc06a483f0d6b00f1647d209b450
+SHA512:
+  metadata.gz: 8e56c3a7c0d58465b87ee3c3d4219e11f53fe26ad7f5a51bb878e0900e00f697a0beb55af85120d3a4381f46066ec0c5f62dafb970a92f22cf532f170eaca9b6
+  data.tar.gz: 9b85d360a731d21850820c23ee8085b0fbb801b0e2e9ca825f13a415d26154525b04d91a9faf62386483902d02a9aa36fbfb406d8bb64a584ef5ba63ea4fa11f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in panko.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Barsoom AB
+
+MIT License
+
+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,41 @@
+# Panko
+
+Ruby breadcrumb trail generation the right way: object oriented outside the controller.
+
+Super WiP!
+
+## TODO
+
+  * specs
+  * docs
+  * re-implement what we currently depend on breadcrumbs_on_rails for
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'panko'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install panko
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/panko/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Thanks to
+
+Thanks to Scott Burton for letting us [take over](http://www.scottburton.me/) the brilliant "Panko" gem name.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/panko.rb

@@ -0,0 +1,6 @@
+module Panko
+end
+
+require "panko/version"
+require "panko/base"
+require "panko/crud"

data/lib/panko/base.rb

@@ -0,0 +1,35 @@
+require "attr_extras"
+require "i18n"
+require "active_support/all"
+
+class Panko::Base
+  pattr_initialize :controller
+
+  def build
+    add_root
+  end
+
+  private
+
+  def add_root
+    add_breadcrumb t("layout.breadcrumb_root"), root_path
+  end
+
+  def t(*opts)
+    I18n.t(*opts)
+  end
+
+  # Delegate *_path to the controller.
+  def method_missing(name, *args)
+    if name.to_s.end_with?("_path")
+      controller.public_send(name, *args)
+    else
+      super
+    end
+  end
+
+  private
+
+  delegate :add_breadcrumb, :url_for,
+    to: :controller
+end

data/lib/panko/crud.rb

@@ -0,0 +1,67 @@
+require "panko/base"
+
+class Panko::Crud < Panko::Base
+  pattr_initialize :controller, :persisted_record
+
+  def build
+    super
+    add_index
+    add_show
+    add_new_or_edit
+  end
+
+  private
+
+  def record_class
+    # E.g. "EmployeesBreadcrumbs" -> Employee.
+    self.class.name.sub(/Breadcrumbs$/, "").
+      singularize.constantize
+  end
+
+  def add_index
+    add_breadcrumb t("#{t_scope}.index.title"), index_path
+  end
+
+  def add_show
+    if persisted_record
+      add_breadcrumb persisted_record.to_s, show_path
+    end
+  end
+
+  def add_new_or_edit
+    if new?
+      add_breadcrumb t("#{t_scope}.new.title"), nil
+    elsif edit?
+      add_breadcrumb t("#{t_scope}.edit.title"), nil
+    end
+  end
+
+  def t_scope
+    # E.g. "employees".
+    record_class.name.tableize
+  end
+
+  def index_path
+    url_for(index_context)
+  end
+
+  def show_path
+    url_for(show_context)
+  end
+
+  def index_context
+    [ record_class ]
+  end
+
+  def show_context
+    [ persisted_record ]
+  end
+
+  def edit?
+    %w[edit update].include?(controller.action_name)
+  end
+
+  def new?
+    %w[new create].include?(controller.action_name)
+  end
+end

data/lib/panko/version.rb

@@ -0,0 +1,3 @@
+module Panko
+  VERSION = "0.0.2"
+end

data/panko.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'panko/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "panko"
+  spec.version       = Panko::VERSION
+  spec.authors       = ["Joakim Kolsjö", "Henrik Nyh"]
+  spec.email         = ["all@barsoom.se"]
+  spec.summary       = %q{Breadcrumb trails the right way: object-oriented outside the controller.}
+  spec.homepage      = "https://github.com/barsoom/panko"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "attr_extras"
+  spec.add_dependency "breadcrumbs_on_rails"
+  spec.add_dependency "i18n"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/crud_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require "panko/crud"
+
+class Item
+  def to_s
+    "Item 123"
+  end
+end
+
+class ItemBreadcrumbs < Panko::Crud
+end
+
+describe Panko::Crud, "#build" do
+  let(:controller) { double(:controller, super_admin?: false, action_name: action_name, root_path: "/") }
+
+  context "in controller #index" do
+    let(:action_name) { "index" }
+
+    it "builds an index breadcrumb" do
+      expect_i18n "layout.breadcrumb_root" => "My root",
+                  "items.index.title"      => "Items"
+
+      expect_url_for [ Item ] => "/items"
+
+      expect_to_add_breadcrumb("My root", "/")
+      expect_to_add_breadcrumb("Items", "/items")
+
+      ItemBreadcrumbs.new(controller, nil).build
+    end
+  end
+
+  context "in controller #show" do
+    let(:action_name) { "show" }
+    let(:item) { Item.new }
+
+    it "builds a show breadcrumb" do
+      expect_i18n "layout.breadcrumb_root" => "My root",
+                  "items.index.title"      => "Items"
+
+      expect_url_for [ Item ] => "/items",
+                     [ item ] => "/items/123"
+
+      expect_to_add_breadcrumb("My root", "/")
+      expect_to_add_breadcrumb("Items", "/items")
+      expect_to_add_breadcrumb("Item 123", "/items/123")
+
+      ItemBreadcrumbs.new(controller, item).build
+    end
+  end
+
+  private
+
+  def expect_i18n(hash)
+    hash.each do |key, value|
+      expect(I18n).to receive(:t).with(key).and_return(value)
+    end
+  end
+
+  def expect_url_for(hash)
+    hash.each do |args, value|
+      expect(controller).to receive(:url_for).with(args).and_return(value)
+    end
+  end
+
+  def expect_to_add_breadcrumb(name, path)
+    expect(controller).to receive(:add_breadcrumb).with(name, path)
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: panko
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Joakim Kolsjö
+- Henrik Nyh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: breadcrumbs_on_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- all@barsoom.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/panko.rb
+- lib/panko/base.rb
+- lib/panko/crud.rb
+- lib/panko/version.rb
+- panko.gemspec
+- spec/crud_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/barsoom/panko
+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.2.0
+signing_key: 
+specification_version: 4
+summary: 'Breadcrumb trails the right way: object-oriented outside the controller.'
+test_files:
+- spec/crud_spec.rb
+- spec/spec_helper.rb