view_models 2.0.1 → 3.0.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_WITHOUT: ""

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+log/*.log
+tmp
+coverage
+pkg
+.rbx
+
+rails/log/*.log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--profile

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@view_models

data/.travis.yml

@@ -0,0 +1,19 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx-18mode
+  - rbx-19mode
+  - jruby
+
+script: "bundle exec rake spec cucumber"
+
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/3.1.Gemfile
+  - gemfiles/3.0.Gemfile
+  
+matrix:
+  allow_failures:
+    - rvm: jruby

data/.yardoc/checksums

@@ -0,0 +1,13 @@
+lib/view_models.rb cdce5ced48e3d6147b31568f800e5222317b54f2
+lib/view_models/base.rb 75e818e1f843a43cf8194a92dc77f4019362e68f
+lib/view_models/view.rb 438b98e8068703cf99e010b10b01e6e484b3b8bf
+lib/view_models/version.rb db9c82d8d0eca0c06c6c984da4e1deb4883b382b
+lib/view_models/path_store.rb 8e4b11a73e6d8f1a89bad01b143ddd8a4a20136f
+lib/view_models/helpers/view.rb 6633aced3a9aa969a7b724ed5569b405a4eb3485
+lib/view_models/render_options.rb 7aaf1f6a8f23dddd7da5edc54a57eec5559e5aa3
+lib/view_models/extensions/view.rb 6a5397c357ec1c602ae5d0b8022fa8c10411301c
+lib/view_models/helpers/mapping.rb adf576f9fa3b2a99697e4c2851ae79a1fcf15811
+lib/view_models/context_extractor.rb 37a7419a5b04f7aff344ddf130dbdaee0f9f4fed
+lib/view_models/helpers/collection.rb 57aabb6a4738cfe2c2f2795b561b0d58ffa1ac67
+lib/view_models/extensions/model_reader.rb 1f7c1cc73fad44d30bc66a76720d9ee237ba63fe
+lib/rails/generators/view_models/view_models_generator.rb 8e3754d601a82bcbe71665e0cd810c3336b19e3e

data/Appraisals

@@ -0,0 +1,15 @@
+appraise '3.0' do
+  gem 'rails', '~> 3.0.0'
+end
+
+appraise '3.1' do
+  gem 'rails', '~> 3.1.0'
+  gem 'jquery-rails'
+  gem 'sass-rails'
+end
+
+appraise '3.2' do
+  gem 'rails', '~> 3.2.0'
+  gem 'jquery-rails'
+  gem 'sass-rails'
+end

data/CHANGELOG

@@ -0,0 +1,31 @@
+3.0.0 - 28.10.12 - beatrichartz: Rails 3 Version of view models
+2.0.0 - 21.06.10 - floere: Dualboot (Padrino/Rails2) gem.
+1.6.0 - 15.06.10 - floere: Added Padrino to the frameworks.
+                           Changed visibility of methods model, context (controller, app) from public to protected.
+                           (Opinionated Discouragement – make them public if you feel accessing the model directly is ok.)
+1.5.2 - 25.02.10 - floere: The capture method - if included per Capturehelper - works now in view models.
+1.5.1 - 22.02.10 - floere: Renamed ViewModels::Helper to ViewModels::Helpers.
+1.5.0 - 20.02.10 - floere: format propagates through collection rendering
+                           render_as, new sig: :partial => to explicitly define the partial. (Syntactic Discouragement)
+                           Added: render_with, an alias of render_as.
+                           Added: render_template, to render non-partials.
+1.4.2 - 10.02.10 - floere: render_as does not check the deprecated API anymore. Use the new options
+                           form to pass a format.
+                 - floere: MissingViewModelError is not thrown anymore.
+                 - floere: include ViewModels::Extensions::ActiveRecord in your Project view model to
+                           give id, dom_id, to_param capabilities to your view_models. Or include in a
+                           subclass.
+1.4.0 - 08.02.10 - floere: Changed Api of ViewModels::Base#render_as to go up through the view model
+                           class hierarchy to find a partial.
+1.3.0 - 29.01.10 - andi:   Changed Api of ViewModels::Base#render_as to take an options hash. Now supports
+                           passing locals to the render call.
+1.2.0 - 13.01.10 - floere: Simple generator written.
+1.1.0 - 30.06.09 - floere: Rewrite: Representer => ViewModel.
+1.0.2 - 08.08.08 - floere: Renamed Representers::Helper::Rails to Representers::Helper::Rails.
+                 - floere: Added Representers::Helpers::View for conveniently integrating common view-helpers.
+                 - floere: Added controller_methods for RequestForgeryProtection in ViewModels::Base.
+                 - floere: Added methods for id and dom_id in Representers::ActiveRecord.
+                 - floere: Included ActionController::Helpers in Representers::Base and removed own helper-method.
+                 - floere: Changed visibility of method view_instance in Representers::Base from private to protected.
+1.0.1 - 24.07.08 - floere: Rewrite: Presenter => Representer.
+1.0.0 - May 2008 - floere: Initial commit.

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gemspec
+
+gem 'sqlite3', :platform => :ruby
+
+# Can't wrap in platform :jruby do...end block because appraisal doesn't support
+# it
+gem 'activerecord-jdbc-adapter',        :platform => :jruby
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'jdbc-sqlite3',                     :platform => :jruby
+gem 'jruby-openssl',                    :platform => :jruby
+gem 'therubyrhino',                     :platform => :jruby

data/Gemfile.lock

@@ -0,0 +1,174 @@
+PATH
+  remote: .
+  specs:
+    view_models (3.0.0)
+      actionmailer (>= 3.0.0)
+      actionpack (>= 3.0.0)
+      activerecord (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    aruba (0.4.11)
+      childprocess (>= 0.2.3)
+      cucumber (>= 1.1.1)
+      ffi (>= 1.0.11)
+      rspec (>= 2.7.0)
+    builder (3.0.3)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    cucumber-rails (1.3.0)
+      capybara (>= 1.1.2)
+      cucumber (>= 1.1.8)
+      nokogiri (>= 1.5.0)
+    database_cleaner (0.8.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (2.6.4)
+      activesupport (>= 2.3.9)
+    factory_girl_rails (1.7.0)
+      factory_girl (~> 2.6.0)
+      railties (>= 3.0.0)
+    ffi (1.1.5)
+    gherkin (2.11.2)
+      json (>= 1.4.6)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    libwebsocket (0.1.5)
+      addressable
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    slim (1.3.0)
+      temple (~> 0.4.1)
+      tilt (~> 1.3.3)
+    slim-rails (1.0.3)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      slim (~> 1.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    temple (0.4.1)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.11)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord-jdbc-adapter
+  activerecord-jdbcsqlite3-adapter
+  appraisal (~> 0.4.0)
+  aruba
+  bundler (>= 1.1.0)
+  cucumber
+  cucumber-rails
+  database_cleaner
+  factory_girl (~> 2.6.4)
+  factory_girl_rails (~> 1.7.0)
+  jdbc-sqlite3
+  jruby-openssl
+  rake (>= 0.8.7)
+  rspec-rails (~> 2.11.0)
+  slim-rails (~> 1.0.0)
+  sqlite3
+  therubyrhino
+  view_models!
+  yard

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Florian Hanke & Kaspar Schiess
+
+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.textile

@@ -0,0 +1,199 @@
+h1. View Models !https://secure.travis-ci.org/beatrichartz/view_models.png(Build Status)!:http://travis-ci.org/beatrichartz/view_models "!https://codeclimate.com/badge.png!":https://codeclimate.com/github/beatrichartz/view_models
+
+A representer solution for Rails 3. For older versions of Rails please use versions up to 3. You may find view models useful (or not). Fact: They will keep code out of your views. Because view models do not like code in your view.
+
+h2. Installing View Models
+
+Add this to your gemfile
+
+<pre><code>gem "view_models",   ">= 3.0.0"
+</code></pre>
+
+And this to your application.rb: (It adds the app folder to the autoload paths, which is necessary for the view models to load)
+<pre><code>config.autoload_paths += %W(#{config.root}/app)
+</code></pre>
+
+Create a directory "view_models" in your app folder, and you're good to go.
+<pre><code>mkdir ./app/view_models
+</code></pre>
+
+h2. TODOs
+
+What you can look forward to in future versions of this gem:
+- Bootstrapping for easier installation
+- JSON generation out of view models
+
+h2. Basic Usage
+
+Let's say you have a model User (with a first and a last name and an address in the database):
+
+<pre><code>class User < ActiveRecord::Base
+  
+  has_many :posts
+  
+end
+</code></pre>
+
+Write a corresponding view model user.rb in your view_models folder
+
+<pre><code>class ViewModels::User < ViewModels::Base
+  
+  # model readers make model methods accessible on the view model object
+  #
+  model_reader :first_name, :last_name, :street, :street_number, :zip_code, :city
+  
+  # Write helper methods which benefit from model readers
+  #
+  def name
+    [first_name, last_name].join ' '
+  end
+  
+  # Access the model by using «model»
+  #
+  def creation_time
+    time_ago_in_words model.created_at
+  end
+  
+end
+</code></pre>
+
+In your view, call the view_model for a model by using «view_model_for»
+
+<pre><code>- view_model = view_model_for(@user)
+%h2= view_model.name
+%h2= view_model.creation_time
+</code></pre>
+
+All beautiful, you may think, but...
+
+h2. Why View Models? (aka «The Problem»)
+
+Ever felt like putting something like this in your views (example in haml)?
+
+<pre><code>#user
+  .name= [@user.first_name, @user.last_name].join ' '
+  .address= [@user.street, @user.street_number, @user.zip_code, @user.city].join ' '
+</code></pre>
+
+Well, that may feel good if you're in a hurry. Soon there comes the time when you use this code in more than one place. Time to build a helper:
+
+<pre><code>module UserHelper
+  def user_name user
+    [user.first_name, user.last_name].join ' '
+  end
+
+  def user_address user
+    [user.street, user.street_number, user.zip_code, user.city].join ' '
+  end
+end
+
+#user
+  .name= user_name @user
+  .address= user_address @user
+</code></pre>
+
+It may be a lot cleaner, but something just does not feel right. Right, but what? Well, for instance, you have to namespace all your methods with «user» so your methods don't get messy. Second, you have to include the helper either in every context you use it, or even in the whole app. If only you had a polymorphic object to represent your models in the views...
+
+h3. Meet View Models (aka «The Solution»)
+
+View models are pretty, because they represent your models in your views. They look good in every context, and therefore make you look good, too. Take our example from before:
+
+<pre><code>class ViewModels::User < ViewModels::Base
+
+  model_reader :first_name, :last_name, :street, :street_number, :zip_code, :city
+  
+  def name
+    [first_name, last_name].join ' '
+  end
+
+  def address
+    [street, street_number, zip_code, city].join ' '
+  end
+  
+end
+</code></pre>
+
+And your view will look like this:
+
+<pre><code>- user_view_model = view_model_for(@user)
+#user
+  .name= user_view_model.name
+  .address= user_view_model.address
+</code></pre>
+
+No helper inclusion needed, no further noise involved. In fact, you can make it even prettier: What if you needed that partial with the user name and address somewhere else in your code?
+
+h3. Meet View Models render_as method
+
+View models feature template rendering: You can render any partial in your views, following your views directory tree structure: A view_model variable will automatically be included as a local variable in your partial if you render it with view models:
+
+Let's say you have the user model from before, and the following partial written for the view model to render named "info":
+
+<pre><code>#user
+  .name= view_model.name
+  .address= view_model.address
+</code></pre>
+
+Now everything you have to do to render that partial is:
+
+<pre><code>= view_model_for(@user).render_as :info
+</code></pre>
+
+View models feature hierarchical template rendering. That means, if you have a parent view model which has an identical partial already installed, you do not need to copy identical code just to render the same template. The view model will lookup its inheritance chain and Rails template paths to find the suitable partial. Which brings us to another great feature:
+
+h3. View Models can haz inheritance
+
+Ever tried to do inheritance in Rails helpers? Right. View Models, on the other side, love inheritance. They do not need arguments to display a formatted creation time for all your models. Consider the following:
+
+h4. The View Model Way
+
+You can generate a view model tree structure with a view model for your whole app for your other view models to inherit from. The polymorphic class matching of the view models ignores the missing class YourApp candidly.
+
+<pre><code>class ViewModels::YourApp < ViewModels::Base
+
+  def creation_time
+    time_ago_in_words model.created_at
+  end
+
+end
+
+class ViewModels::User < ViewModels::YourApp
+end
+</code></pre>
+
+In your view:
+
+<pre><code>= view_model_for(@user).creation_time
+</code></pre>
+
+h4. The Helper Way
+
+Imagine how to do this in a helper ? Well, better go ahead and use time_ago_in_words everywhere.
+
+h2. Where is it used?
+
+There are known some places in the big place called internet to use this gem:
+
+"rightclearing.com [Music Licensing Provider]": http://rightclearing.com
+"restorm.com [Music Platform]": http://restorm.com
+
+h2. Testing View Models
+
+Testing View Models is easy. You can use the view models initializer instead of the view_model_for mapping (example in rspec with factory girl):
+
+<pre><code>describe "ViewModels::User" do
+  let(:user) { build_stubbed(:user) }
+  subject { ViewModels::User.new(user, @controller) } # @controller may be nil or the controller
+  
+  describe "model_readers"
+    .. there you go
+  end
+end
+</code></pre>
+
+h2. Further reads
+
+"Mailing List":http://groups.google.com/group/view_models/topics
+"Rubygems":http://rubygems.org/gems/view_models
+"Bug Tracker":http://github.com/floere/view_models/issues
+"Source [Github]":http://github.com/floere/view_models