view_models 2.0.1 → 3.0.0

data/feature_support/testapp/lib/tasks/cucumber.rake

@@ -0,0 +1,31 @@
+require 'cucumber/rake/task'
+
+namespace :cucumber do
+  Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'default'
+  end
+
+  Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'wip'
+  end
+
+  Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'rerun'
+  end
+
+  desc 'Run all features'
+  task :all => [:ok, :wip]
+
+  task :statsetup do
+    require 'rails/code_statistics'
+    ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+    ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+  end
+end
+
+task :cucumber => 'cucumber:all'
+
+task :default => :cucumber

data/feature_support/testapp/spec/factories/heroes.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :hero do |h|
+    h.birth_date  { 1000.years.ago }
+    h.gender      false
+    h.sequence(:name) {|i| "Thor No #{i}" }
+  end
+end

data/feature_support/testapp/spec/factories/users.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :user do |u|
+    u.birth_date  { 24.years.ago }
+    u.gender      true
+    u.sequence(:name) {|i| "Elvis Presley No #{i}" }
+  end
+end

data/features/rails_integration.feature

@@ -0,0 +1,21 @@
+Feature: integrate with Rails
+
+  Background:
+    When I generate a new rails application
+    And  I copy the generic app files from the support folder into the generated app
+    And  I configure the application to use the view_models gem from this project
+    And  I configure the application to use the following gems
+      | Name                  | Version   | Require |
+      | factory_girl_rails    | ~> 1.7.0  |         |
+      | factory_girl          | ~> 2.6.4  |         |
+      | cucumber-rails        | ~> 1.3.0  | false   |
+      | rspec-rails           | ~> 2.11.0 |         |
+      | capybara              | ~> 1.1.2  |         |
+      | slim-rails            | ~> 1.0.3  |         |
+    And  I successfully run `bundle install --local`
+    And  I successfully run `bundle exec rake db:migrate`
+    
+  Scenario:
+    When I successfully run `bundle exec rake cucumber`
+    Then the output should contain "2 scenarios (2 passed)"
+    And the output should contain "17 steps (17 passed)"

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,112 @@
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+APP_NAME     = 'testapp'.freeze
+
+BUNDLE_ENV_VARS = %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE)
+ORIGINAL_BUNDLE_VARS = Hash[ENV.select{ |key,value| BUNDLE_ENV_VARS.include?(key) }]
+
+Before do
+  ENV['BUNDLE_GEMFILE'] = File.join(Dir.pwd, ENV['BUNDLE_GEMFILE']) unless ENV['BUNDLE_GEMFILE'].start_with?(Dir.pwd)
+end
+
+After do
+  ORIGINAL_BUNDLE_VARS.each_pair do |key, value|
+    ENV[key] = value
+  end
+end
+
+When 'I generate a new rails application' do
+  steps %{
+    When I run `rails new #{APP_NAME}`
+    And I cd to "#{APP_NAME}"
+    And I comment out the gem "turn" from the Gemfile
+    And I comment out the gem "coffee-rails" from the Gemfile
+    And I comment out the gem "uglifier" from the Gemfile
+    And I reset Bundler environment variables
+    And I set the "BUNDLE_GEMFILE" environment variable to "Gemfile"
+    And I successfully run `bundle install --local`
+  }
+  if RUBY_VERSION >= "1.9.3"
+    append_to_gemfile %(gem "rake", "~> 0.9.3.beta.1")
+    step %(I successfully run `bundle update rake`)
+  end
+end
+
+When /^I copy the generic app files from the support folder into the generated app$/ do
+  FileUtils.cp_r File.join(PROJECT_ROOT, 'feature_support/testapp'), File.join(PROJECT_ROOT, 'tmp/aruba'), :remove_destination => true
+end
+
+When /^I configure the application to use the (.+) gem from this project$/ do |name|
+  append_to_gemfile "gem '#{name}', :path => '#{PROJECT_ROOT}'"
+end
+
+When /^I configure the application to use "([^\"]+)" from this project in test and development$/ do |name|
+  append_to_gemfile <<-GEMFILE
+  group :test, :development do
+    gem '#{name}', :path => '#{PROJECT_ROOT}'
+  end
+  GEMFILE
+end
+
+When 'I run the rspec generator' do
+  steps %{
+    When I successfully run `rails generate rspec:install`
+  }
+end
+
+When 'I configure the application to use the following gems' do |table|
+  table.hashes.each do |hash|
+    if hash[:Require] && hash[:Require].strip.size > 0
+      append_to_gemfile "gem '#{hash[:Name]}', '#{hash[:Version]}', :require => #{hash[:Require]}\n"
+    else
+      append_to_gemfile "gem '#{hash[:Name]}', '#{hash[:Version]}'\n"
+    end
+  end
+  
+end
+
+When /^I set the "([^"]*)" environment variable to "([^"]*)"$/ do |key, value|
+  ENV[key] = value
+end
+
+When 'I append gems from Appraisal Gemfile' do
+  File.read(ENV['BUNDLE_GEMFILE']).split("\n").each do |line|
+    if line =~ /^gem "(?!rails|appraisal)/
+      append_to_gemfile line.strip
+    end
+  end
+end
+
+When 'I reset Bundler environment variables' do
+  BUNDLE_ENV_VARS.each do |key|
+    ENV[key] = nil
+  end
+end
+
+When /^I comment out the gem "([^"]*)" from the Gemfile$/ do |gemname|
+  comment_out_gem_in_gemfile(gemname)
+end
+
+module FileHelpers
+  def append_to(path, contents)
+    in_current_dir do
+      File.open(path, "a") do |file|
+        file.puts
+        file.puts contents
+      end
+    end
+  end
+
+  def append_to_gemfile(contents)
+    append_to('Gemfile', contents)
+  end
+
+  def comment_out_gem_in_gemfile(gemname)
+    in_current_dir do
+      gemfile = File.read("Gemfile")
+      gemfile.sub!(/^(\s*)(gem\s*['"]#{gemname})/, "\\1# \\2")
+      File.open("Gemfile", 'w'){ |file| file.write(gemfile) }
+    end
+  end
+end
+
+World(FileHelpers)

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'aruba/cucumber'
+require 'factory_girl'
+
+Before do
+  @aruba_timeout_seconds = 120
+end

data/gemfiles/3.0.Gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "sqlite3", :platform=>:ruby
+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
+gem "rails", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/3.1.Gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "sqlite3", :platform=>:ruby
+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
+gem "rails", "~> 3.1.0"
+gem "jquery-rails"
+gem "sass-rails"
+
+gemspec :path=>"../"

data/gemfiles/3.2.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "sqlite3", :platform=>:ruby
+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
+gem "rails", "~> 3.2.0"
+gem "jquery-rails"
+gem "sass-rails"
+
+gemspec :path=>"../"

data/lib/rails/generators/view_models/USAGE

@@ -0,0 +1,6 @@
+Usage:
+  rails g view_models <view model class name>
+  rails g view_models User
+  
+  rails g view_models <view model class name> <partials for render_as, separated by space>
+  rails g view_models User compact extensive list_item table_item

data/lib/rails/generators/view_models/templates/views/_collection.html.erb

@@ -0,0 +1,6 @@
+<ul class="collection">
+  <%- collection.each do |item| -%>
+    <%- view_model = view_model_for item -%>
+    <li><%= view_model.render_as template_name -%></li>
+  <%- end -%>
+</ul>

data/lib/{rails2/generators/view_models/templates/views/view_models/collection → rails/generators/view_models/templates/views}/_collection.html.haml

@@ -2,7 +2,6 @@
   - collection.each do |item|
     - view_model = view_model_for item
     %li
-      - options = (template_format ? { :format => template_format } : {})
-      = view_model.render_as template_name, options
+      = view_model.render_as template_name
     = separator unless item == collection.entries.last
         

data/lib/rails/generators/view_models/templates/views/_collection.html.slim

@@ -0,0 +1,6 @@
+ul.collection
+  - collection.each do |item|
+    - view_model = view_model_for item
+    li
+      = view_model.render_as template_name
+    = separator unless item == collection.entries.last

data/lib/rails/generators/view_models/templates/views/_list.html.erb

@@ -0,0 +1,6 @@
+<ol class="collection">
+  <%- collection.each do |item| -%>
+    <%- view_model = view_model_for item -%>
+    <li><%= view_model.render_as template_name -%></li>
+  <%- end -%>
+</ol>

data/lib/rails/generators/view_models/templates/views/_list.html.haml

@@ -0,0 +1,4 @@
+%ol.collection
+  - collection.each do |item|
+    - view_model = view_model_for item
+    %li= view_model.render_as template_name

data/lib/rails/generators/view_models/templates/views/_list.html.slim

@@ -0,0 +1,5 @@
+ol.collection
+  - collection.each do |item|
+    - view_model = view_model_for item
+    li
+      = view_model.render_as template_name

data/lib/rails/generators/view_models/templates/views/_pagination.html.erb

@@ -0,0 +1,18 @@
+<%- if collection.page_count > 1 -%>
+  <p>
+    <%- if collection.previous_page? -%>
+    <%= link_to 'previous', :page => collection.page-1 -%>
+    <%- end -%>
+    <%- 1.upto(collection.page_count) do |page| -%>
+      <%- if page == collection.page -%>
+        <%= page.to_s -%>
+      <%- else -%>
+        <%= link_to page, :page => page -%>
+      <%- end -%>
+    <%- end -%>
+    <%= separator unless collection.last_page? -%>
+    <%- if collection.next_page? -%>
+    <%= link_to 'next', :page => collection.page+1 -%>
+    <%- end -%>
+  </p>
+<%- end -%>

data/lib/{rails2/generators/view_models/templates/views/view_models/collection → rails/generators/view_models/templates/views}/_pagination.html.haml

@@ -1,7 +1,7 @@
 - if collection.page_count > 1
   %p
     - if collection.previous_page?
-      = link_to 'zurückblättern', :page => collection.page-1
+      = link_to 'previous', :page => collection.page-1
     - 1.upto(collection.page_count) do |page|
       - if page == collection.page
         = page.to_s
@@ -9,4 +9,4 @@
         = link_to page, :page => page
       = separator unless collection.last_page?
     - if collection.next_page?
-      = link_to 'vorblättern', :page => collection.page+1
+      = link_to 'next', :page => collection.page+1

data/lib/rails/generators/view_models/templates/views/_pagination.html.slim

@@ -0,0 +1,12 @@
+- if collection.page_count > 1
+  p
+    - if collection.previous_page?
+      = link_to 'previous', :page => collection.page-1
+    - 1.upto(collection.page_count) do |page|
+      - if page == collection.page
+        = page.to_s
+      - else
+        = link_to page, :page => page
+      = separator unless collection.last_page?
+    - if collection.next_page?
+      = link_to 'next', :page => collection.page+1

data/lib/rails/generators/view_models/templates/views/_table.html.erb

@@ -0,0 +1,10 @@
+<table class="collection">
+  <tbody>
+  <%- collection.each do |item| -%>
+    <tr>
+      <%- view_model = view_model_for item -%>
+      <%= view_model.render_as template_name -%>
+    </tr>
+  <%- end -%>
+  </tbody>
+</table>

data/lib/rails/generators/view_models/templates/views/_table.html.slim

@@ -0,0 +1,5 @@
+table.collection
+  - collection.each do |item|
+    tr
+      - view_model = view_model_for item
+      = view_model.render_as template_name

data/lib/rails/generators/view_models/view_models_generator.rb

@@ -0,0 +1,57 @@
+# A generator for view models
+#
+class ViewModelsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :class_name, :type => :string
+  class_option :views, :type => :string, :default => 'erb', :desc => "Render view files in erb, haml or slim (use the language name as the argument)"
+
+  # Generate the view models given
+  #
+  def generate_view_models
+    file_name = class_name.underscore
+    
+    create_model class_name, file_name
+    
+    create_views file_name if options.views.present?
+  end
+  
+  # Create views corresponding to view models
+  #
+  def create_views file_name
+    %W(list_item main_item).each do |view|
+      create_file "app/views/#{file_name.pluralize}/_#{view}.html.#{options.views.downcase}", File.read(File.join(File.expand_path('../templates', __FILE__), "/views/_empty.html.#{options.views.downcase}"))
+    end
+  
+    # Copy collection views.
+    #
+    %W(collection list pagination table).each do |view|
+      create_file "app/views/#{file_name.pluralize}/_#{view}.html.#{options.views.downcase}", File.read(File.join(File.expand_path('../templates', __FILE__), "/views/_#{view}.html.#{options.views.downcase}"))
+    end
+  end
+  
+  # Create the view model files for the view models given
+  #
+  def create_model class_name, file_name
+    # ViewModels
+    #
+    create_file "app/view_models/#{file_name}.rb", <<-FILE
+class ViewModels::#{class_name} < ViewModels::Project
+
+# model_reader :icon, :filter_through => [:h]
+
+end
+    FILE
+
+    # Specs
+    #
+    
+    create_file "spec/view_models/#{file_name}_spec.rb", <<-FILE
+require 'spec_helper'
+
+describe ViewModels::#{class_name} do
+
+end
+    FILE
+
+  end
+end

data/lib/view_models.rb

@@ -1,5 +1,15 @@
-if defined? Padrino
-  require File.join(File.dirname(__FILE__), '/padrino/init')
-else
-  require File.join(File.dirname(__FILE__), '/rails2/init')
-end
+require 'view_models/extensions/model_reader'
+
+require 'view_models/helpers/mapping'
+require 'view_models/helpers/collection'
+require 'view_models/helpers/view'
+
+require 'view_models/path_store'
+require 'view_models/render_options'
+require 'view_models/context_extractor'
+require 'view_models/base'
+
+require 'view_models/view'
+
+ActionController::Base.send :include, ViewModels::Helpers::Mapping
+ActionView::Base.send       :include, ViewModels::Helpers::Mapping