partial_path_customizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83f2818e752af14f6ccf04ea695cc1f8d4b38a82
+  data.tar.gz: 3d253c2b993a5c6f73c87df5447558f63c779b6b
+SHA512:
+  metadata.gz: e41f9a48ea948f96e51d2da0601ead47b3f6dc56a4da1da480cc5b0426fa0f69800052ddca796e2cbc2f25053dbadf3de644456cd108021ce18594f7911ca53e
+  data.tar.gz: e23ef878c7b944c6108ff6a0009871d6da571f904d7bd17f938b70992842160a9c4b8544e1a049e0326d55d566aa2838036267d32f98d2cce0c6c5b604ce29ca

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+gemfiles/*.lock
+*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile

data/Appraisals

@@ -0,0 +1,5 @@
+['4.1.6', '4.0.10', '3.2.19'].each do |rails_version|
+  appraise "rails_#{rails_version[0..2]}" do
+    gem "rails", rails_version
+  end
+end

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in partial_path_customizer.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    partial_path_customizer (0.1.0)
+      dumb_delegator (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    dumb_delegator (0.7.0)
+    erubis (2.7.0)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.2)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec-activemodel-mocks (1.0.1)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      rspec-mocks (>= 2.99, < 4.0)
+    rspec-core (3.1.5)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.1)
+    slop (3.5.0)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  partial_path_customizer!
+  pry
+  rspec-activemodel-mocks
+  rspec-rails (~> 3.0)
+  sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Animas Code Labs
+
+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,76 @@
+# Partial Path Customizer
+
+[![Build Status](https://travis-ci.org/AnimasCodeLabs/partial_path_customizer.svg?branch=master)](https://travis-ci.org/AnimasCodeLabs/partial_path_customizer)
+
+Partial Path Customizer allows you to override `#to_partial_path` for a Rails model at runtime.
+
+## Installation & Upgrading
+
+This gem is a railtie and is meant to be used with Rails. It is tested with versions of Rails down to 3.2.
+
+Partial Path Customizer is recommended to be run as a gem and included in your Gemfile:
+
+```ruby
+gem 'partial_path_customizer'
+```
+
+## Helper
+
+Partial path customizers provides a helper method to automatically set the partial path for the object
+you want to render. Here is how you would render an object normally.
+
+```erb
+<%= render @bike %>
+```
+
+This would render the `bikes/bike` partial. Now if you want to customize the partial path, use the
+`customize_partial_path` like this.
+
+```erb
+<%= render customize_partial_path(@bike, 'summary') %>
+```
+
+This renders the `bikes/summary` partial instead. The partial path with this helper is generated by the
+object's model_name pluralized.
+
+### Heterogenous collections
+
+This is also very useful for rendering heterogenous collections with custom partial paths. For example, if you have
+this collection:
+
+```ruby
+# Somewhere in the controller
+@listings = [Bike.new, Wheelset.new, Bike.new]
+```
+
+and render it like this
+
+```erb
+<%= render @listings %>
+```
+
+it will render the partials `bikes/bike`, `wheelsets/wheels`, and `bikes/bike`. If you would like the partial names
+to to be rendered like `bikes/summary`, `wheelsets/summary`, and `bikes/summary`, you can do this
+
+```erb
+<%= render customize_partial_path(@listings, 'summary') %>
+```
+
+### Customizing partial_path generation
+
+If you need to further customize how the partial path is generated, you can pass a callable object in as the second
+argument. The callable object will receive a reference to the model when it's #call method is called.
+
+```ruby
+<%= render customize_partial_path(@bike, ->(model){ "#{model.class.model_name.singular}/#{model.status}_summary" })
+```
+
+That would allow you to generate a partial path like `bike/sold_summary`.
+
+**Note:** This is a low-level API and the higher level `customize_object_partial_path(<object>, <partial_name>)` should
+be used in most cases.
+
+## License
+
+Partial Path Customizer is Copyright &copy; 2014 Animas Code Labs. It is free software, and may be redistributed
+under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    exec 'rake spec'
+  else
+    Rake::Task['appraise'].execute
+  end
+end
+
+task :appraise => ['appraisal:install'] do |t|
+  exec 'rake appraisal'
+end

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "3.2.19"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0.10"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1.6"
+
+gemspec :path => "../"

data/lib/partial_path_customizer.rb

@@ -0,0 +1,5 @@
+require 'partial_path_customizer/version'
+
+module PartialPathCustomizer
+  require 'partial_path_customizer/railtie' if defined?(Rails)
+end

data/lib/partial_path_customizer/partial_path_helper.rb

@@ -0,0 +1,19 @@
+require 'partial_path_customizer/presenter'
+
+module PartialPathCustomizer::PartialPathHelper
+
+  def customize_partial_path object, partial_name_or_callable
+    partial_path_callable = proc{|model| "#{model.class.model_name.plural}/#{partial_name_or_callable}" }
+
+    if partial_name_or_callable.respond_to?(:call)
+      partial_path_callable = partial_name_or_callable
+    end
+
+    if object.respond_to?(:map)
+      PartialPathCustomizer::Presenter.wrap_collection(object, &partial_path_callable)
+    else
+      PartialPathCustomizer::Presenter.new(object, &partial_path_callable)
+    end
+  end
+
+end

data/lib/partial_path_customizer/presenter.rb

@@ -0,0 +1,34 @@
+require 'dumb_delegator'
+
+class PartialPathCustomizer::Presenter < DumbDelegator
+
+  def self.wrap_collection collection, &partial_path_block
+    collection.map do |obj|
+      new obj, &partial_path_block
+    end
+  end
+
+  def initialize(object, &partial_path_block)
+    super(object)
+    @partial_path_block = partial_path_block
+  end
+
+  def to_partial_path
+    if @partial_path_block.present?
+      @partial_path_block.call(_model)
+    else
+      __getobj__.to_partial_path
+    end
+  end
+
+  def to_model
+    self
+  end
+
+  private
+
+  def _model
+    __getobj__
+  end
+
+end

data/lib/partial_path_customizer/railtie.rb

@@ -0,0 +1,9 @@
+require 'partial_path_customizer/partial_path_helper'
+
+module PartialPathCustomizer
+  class Railtie < Rails::Railtie
+    initializer 'partial_path_customizer.helpers' do |app|
+       ActionView::Base.send :include, PartialPathCustomizer::PartialPathHelper
+    end
+  end
+end

data/lib/partial_path_customizer/version.rb

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

data/lib/tasks/partial_path_customizer_tasks.rake

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

data/partial_path_customizer.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "partial_path_customizer/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "partial_path_customizer"
+  s.version     = PartialPathCustomizer::VERSION
+  s.authors     = ["Aaron Renner"]
+  s.email       = ["aaron@animascodelabs.com"]
+  s.homepage    = "https://github.com/AnimasCodeLabs/partial_path_customizer"
+  s.summary     = "Easily override #to_partial_path on Rails models"
+  s.description = "Easily override #to_partial_path on Rails models"
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'dumb_delegator', '~> 0.6'
+
+  s.add_development_dependency "appraisal"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails", "~> 3.0"
+  s.add_development_dependency "rspec-activemodel-mocks"
+  s.add_development_dependency "pry"
+end

data/spec/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks