rails3_artifactor 0.2.7 → 0.2.8

data/README.markdown

@@ -39,6 +39,10 @@ module MyCoolModule
 end
 </pre>
 
+## Update, Okt. 5 2010
+
+Now includes a very flexible API for specifying view files etc. See *view_file_spec.rb* for usage examples.
+
 ## TODO
 
 Make DSL even better, fx:

data/Rakefile

@@ -7,9 +7,9 @@ begin
     gem.email = "kmandrup@gmail.com"
     gem.homepage = "http://github.com/kristianmandrup/rails3_artifact_helper"
     gem.authors = ["Kristian Mandrup"]
-    gem.add_development_dependency "rspec", "~> 2.0.0.beta.22"
+    gem.add_development_dependency "rspec", ">= 2.0.0.rc"
 
-    gem.add_dependency "rspec",             "~> 2.0.0.beta.22"
+    gem.add_dependency "rspec",             ">= 2.0.0.rc"
     gem.add_dependency "require_all",       "~> 1.2.0"
     gem.add_dependency "sugar-high",        "~> 0.2.10"
     gem.add_dependency 'rails3_assist',     "~> 0.2.10"

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.2.8

data/lib/rails3_artifactor/artifact/file_name/view.rb

@@ -1,34 +1,157 @@
 module Rails3::Assist::Artifact
-  module View
+  module View    
     module FileName
-      DEFAULT_TEMPLATE_LANG = 'html.erb'
-      DEFAULT_REST_ACTION = 'show'
-
       DIR = Rails3::Assist::Artifact::Directory
-          
-      def view_file_name folder, *args
-        action, type, args = get_view_args(args)
+
+      module Helper
+        def default_template_lang 
+          'erb.html'
+        end
+
+        def get_type type
+          case type.to_s
+          when 'erb'
+            'erb.html'
+          when 'haml'
+            'haml.html'
+          else
+            type
+          end
+        end 
+
+        def get_view_type type
+          get_type(type.empty? ? default_template_lang : type)
+        end          
+        
+        def filename_type str 
+          str.split('.')[1..-1].join('.')
+        end
+        
+        def filename_name str  
+          str.gsub /\.(.*)/, ''
+        end
+      end
+
+      # TODO: Refactor all code below to make much more DRY !!!
+      def view_file_name *args
+        folder, action, type = get_view_args(args)
         File.expand_path File.join(DIR.view_dir, folder.to_s, "#{action}.#{type}")
       end 
       
-      def get_view_args args 
+      def get_view_args *args
+        args = args.flatten
+        raise ArgumentError, "view_file_name must be called with one or more arguments to return a view file" if args.size == 0
+        case args.size
+        when 1        
+          SingleArg.get_view_args *args
+        else
+          SingleArg.get_view_args *args 
+        end 
+      end
+    end 
+
+    module SingleArg
+      def self.get_view_args *args
         args = args.flatten
-        action  = DEFAULT_REST_ACTION
-        type    = DEFAULT_TEMPLATE_LANG
-        case args.first
+        arg = args.first
+        case arg
         when Hash
-          action = args.first.delete(:action)
-          type = args.first.delete(:type)
-        when String, Symbol     
-          action = args.delete_at(0)
+          # view_file(:person => :show).should == /views\/person\/show\.html\.erb/          
+          return HashArg.get_view_args arg if arg.keys.size == 1 
+          # view_file(:folder => 'person', :type => :show).should == /views\/person\/show\.html\.erb/         
+          HashArgs.get_view_args *args
+        when Symbol, String 
+          TwoArgs.get_view_args *args
+        end        
+      end
+      
+      module HashArg
+        extend Rails3::Assist::Artifact::View::FileName::Helper
+        
+        # view_file(:person => :show).should == /views\/person\/show\.html\.erb/          
+        def self.get_view_args one_hash 
+          folder = one_hash.keys.first.to_s
+          filename = one_hash.values.first.to_s
+          action = filename_name filename
+          type = get_view_type(filename_type filename)
+          [folder, action, type]
         end
-        case args.first
-        when String, Symbol        
-          type = args.delete_at(0)
-        end      
-        [action || DEFAULT_REST_ACTION, type || DEFAULT_TEMPLATE_LANG, args]
       end
-    end 
+
+      module HashArgs
+        extend Rails3::Assist::Artifact::View::FileName::Helper
+        
+        # view_file(:folder => 'person', :action => :show, :type => :erb).should == /views\/person\/show\.html\.erb/         
+        def self.get_view_args hash 
+          folder = hash[:folder]          
+          action = hash[:action]
+          type = get_view_type(hash[:type])
+          [folder, action, type]
+        end
+      end
+
+      module StringArg
+        extend Rails3::Assist::Artifact::View::FileName::Helper
+
+        # view_file('person/show').should == /views\/person\/show\.html\.erb/                         
+        def self.get_view_args string 
+          path_lvs = string.split('/')
+          raise ArgumentError, "view must be in a subfolder #{args}" if path_lvs.size < 2
+          folder = path_lvs[0..-2].join('/')
+          filename = path_lvs.last
+          action = filename_name filename
+          type = get_view_type(filename_type filename)
+          [folder, action, type]
+        end
+      end
+    end
+
+    module TwoArgs                
+      def self.get_view_args *args
+        args = args.flatten
+        arg2 = args[1]
+        case arg2
+        when String, Symbol
+          # view_file(:person, :show).should == /views\/person\/show\.html\.erb/
+          # view_file('person/admin', :show, :type => :erb).should == /views\/person\/show\.html\.erb/
+          TwoLabels.get_view_args args
+        when Hash
+          # view_file(:show, :folder => 'person', :type => :erb).should == /views\/person\/show\.html\.erb/
+          ActionAndHash.get_view_args args
+        end        
+      end
+      
+      module TwoLabels
+        extend Rails3::Assist::Artifact::View::FileName::Helper
+
+        # view_file(:person, :show).should == /views\/person\/show\.html\.erb/
+        # view_file('person/admin', :show, :type => :erb).should == /views\/person\/show\.html\.erb/
+        def self.get_view_args *args
+          args = args.flatten 
+          folder = args.first.to_s
+          action = args[1].to_s
+          hash = args[2] if args.size > 2
+          type = get_view_type(hash ? hash[:type] : nil)
+          [folder, action, type]
+        end        
+      end
+
+      module ActionAndHash
+        extend Rails3::Assist::Artifact::View::FileName::Helper
+        
+        # view_file(:show, :folder => 'person', :type => :erb).should == /views\/person\/show\.html\.erb/
+        def self.get_view_args *args
+          args = args.flatten 
+          action = args.first.to_s
+
+          hash = args.last
+          folder = hash[:folder]
+          type = get_view_type(hash[:type])
+          
+          [folder, action, type]
+        end        
+      end                
+    end
     
     include FileName
     extend FileName

data/lib/rails3_artifactor/artifact/view_artifact.rb

@@ -7,6 +7,18 @@ module Rails3::Assist::Artifact
       file_name = view_file_name(name, args)
       file_name.path.file?
     end
+
+    def has_views? *args, &block
+      options = last_option args
+      args.to_strings.each do |name|
+        return false if !has_view? name, options
+      end
+      true
+    end
+
+    def view_file name, *args
+      view_file_name(name, args)
+    end
     
     # CREATE
     def create_view name, *args, &block
@@ -31,9 +43,8 @@ module Rails3::Assist::Artifact
     def read_view name, *args, &block
       file_name = view_file_name(name, args)
       debug "reading from: #{file_name}"
-      file = File.new(file_name)
-      raise "The view file: #{file} could not be found" if !file
       begin
+        file = File.new(file_name)
         content = file.read
         debug "read content: #{content}"
         yield content if block
@@ -44,13 +55,17 @@ module Rails3::Assist::Artifact
     end
     
     # UPDATE
-    def insert_into_view name, *args, &block
-      file_name = view_file_name(name, args)
-      debug "file insertion (view): #{file_name}"
-      options = last_option args
-      raise ArgumentError, ":before or :after option must be specified for insertion" if !(options[:before] || options[:after])
-      
-      File.insert_into file_name, options, &block
+    def insert_into_view *args, &block
+      begin
+        file_name = view_file_name(args)
+        debug "file insertion (view): #{file_name}"
+        options = last_option args
+        raise ArgumentError, ":before or :after option must be specified for insertion" if !(options[:before] || options[:after])
+        File.insert_into file_name, options, &block
+        true
+      rescue
+        nil
+      end
     end
 
     # DELETE

data/lib/rails3_artifactor/base/crud/delete.rb

@@ -1,8 +1,18 @@
 require 'sugar-high/array'
 
+require 'rails3_artifactor/artifact/file_name/view'
+
 module Rails3::Assist::Artifact::CRUD
   module Delete
-    def remove_artifact name, type
+    class ViewHelper
+      extend Rails3::Assist::Artifact::View::FileName
+    end
+    
+    def remove_artifact name, *args
+      file = ViewHelper.view_file_name(name, args)       
+      return FileUtils.rm_f(file) if File.exist?(file) 
+      
+      type = args.first  
       type = type[:type] if type.kind_of? Hash
       begin
         file = existing_file_name name, type

data/rails3_artifactor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails3_artifactor}
-  s.version = "0.2.7"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-05}
+  s.date = %q{2010-10-07}
   s.description = %q{Helpers for handling Rails 3 artifacts in general, such as CRUD operations etc.}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -58,6 +58,7 @@ Gem::Specification.new do |s|
      "lib/rails3_artifactor/rspec/configure.rb",
      "rails3_artifactor.gemspec",
      "spec/fixtures.rb",
+     "spec/fixtures/app/views/account/edit.erb.html",
      "spec/fixtures/app/views/account/edit.html.erb",
      "spec/rails3_artifactor/artifact/base_spec.rb",
      "spec/rails3_artifactor/artifact/crud/controller_spec.rb",
@@ -69,7 +70,7 @@ Gem::Specification.new do |s|
      "spec/rails3_artifactor/artifact/crud/observer_spec.rb",
      "spec/rails3_artifactor/artifact/crud/permit_spec.rb",
      "spec/rails3_artifactor/artifact/crud/view_controller_action_spec.rb",
-     "spec/rails3_artifactor/artifact/crud/view_controller_default_action_spec.rb",
+     "spec/rails3_artifactor/artifact/crud/view_file_spec.rb",
      "spec/rails3_artifactor/artifact/file_name/artifacts_spec.rb",
      "spec/rails3_artifactor/artifact/file_name/migration_spec.rb",
      "spec/rails3_artifactor/artifact/file_name/view_spec.rb",
@@ -104,7 +105,7 @@ Gem::Specification.new do |s|
      "spec/rails3_artifactor/artifact/crud/observer_spec.rb",
      "spec/rails3_artifactor/artifact/crud/permit_spec.rb",
      "spec/rails3_artifactor/artifact/crud/view_controller_action_spec.rb",
-     "spec/rails3_artifactor/artifact/crud/view_controller_default_action_spec.rb",
+     "spec/rails3_artifactor/artifact/crud/view_file_spec.rb",
      "spec/rails3_artifactor/artifact/file_name/artifacts_spec.rb",
      "spec/rails3_artifactor/artifact/file_name/migration_spec.rb",
      "spec/rails3_artifactor/artifact/file_name/view_spec.rb",
@@ -128,23 +129,23 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
-      s.add_runtime_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.rc"])
+      s.add_runtime_dependency(%q<rspec>, [">= 2.0.0.rc"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.10"])
       s.add_runtime_dependency(%q<rails3_assist>, ["~> 0.2.10"])
       s.add_runtime_dependency(%q<migration_assist>, ["~> 0.1.4"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
-      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
       s.add_dependency(%q<rails3_assist>, ["~> 0.2.10"])
       s.add_dependency(%q<migration_assist>, ["~> 0.1.4"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
-    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
     s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
     s.add_dependency(%q<rails3_assist>, ["~> 0.2.10"])

data/spec/fixtures/app/views/account/edit.erb.html

@@ -0,0 +1,3 @@
+
+        <h1><%= title %></h1>
+      

data/spec/rails3_artifactor/artifact/crud/view_controller_action_spec.rb

@@ -21,34 +21,27 @@ describe 'view API - symbols' do
   context "Non-existant view(s)" do
 
     it "should not fail trying to remove non-existant views" do
-
       remove_views :edit, :show, :folder => :person
       remove_artifacts :view, :edit, :show, :folder => :person
 
       remove_view :show, :folder => :person
-      # remove_artifact :view, :show, :folder => :person
+      remove_artifact :view, :show, :folder => :person
     end
   
     it "should not find a non-existant view" do
-      pending "TODO"
-
       view_file :show, :folder => :person do |person|
         fail "should not find person view!"
       end                                       
     
       has_view?(:show, :folder => :person).should be_false
-      has_views?(:show, :folder => :person).should be_false
+      has_views?(:show, :edit, :folder => :person).should be_false
     end
      
     it "should not insert into non-existant view" do
-      pending "TODO"
-
       insert_into_view(:show, :folder => :person, :after => 'Hello', :content => 'Yes').should_not be_true
     end
   
     it "should not read from non-existant view" do
-      pending "TODO"
-
       read_view :show, :folder => :person do |content|
         fail "should not find person content!"
       end.should_not be_true
@@ -62,43 +55,6 @@ describe 'view API - symbols' do
     end
     puts read_view(:account, :edit)
     read_view(:account, :edit).should have_comment 'hello'
-
-    # root_dir.should have_view :account do |view_file|
-    #   view_file.should have_method :index
-    #   view_file.should have_comment 'hello'
-    #   view_file.should have_comment 'goodbye'
-    # end
   end
 end     
 
-# describe 'view API - hash' do
-#   use_helpers :app, :view
-# 
-#   before :each do              
-#     remove_view :account, :action => :edit
-#     create_view :account, :action => :edit do
-#       %q{
-#         <h1><%= title %></h1>
-#       }
-#     end    
-#   end
-# 
-#   after :each do              
-#     # remove_view :account
-#   end
-#     
-#   it "should have an account_view file that contains an index method and two inserted comments" do
-#     insert_into_view :account, :action => :edit, :content => '# hello', :before => '<h1>'
-#     insert_into_view :account, :action => :edit, :before => '<h1>' do
-#       '# goodbye'
-#     end
-#     puts read_view(:account, :action => :edit)
-#     read_view(:account, :action => :edit).should have_comment 'hello'
-#     puts view_file_name(:account, :edit)
-#     # root_dir.should have_view :account do |view_file|
-#     #   view_file.should have_method :index
-#     #   view_file.should have_comment 'hello'
-#     #   view_file.should have_comment 'goodbye'
-#     # end
-#   end
-# end

data/spec/rails3_artifactor/artifact/crud/view_file_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'view API - symbols' do
+  use_helpers :view
+
+  def simple_path_expr str
+    /#{Regexp.escape(str)}/    
+  end
+
+  before :each do              
+    Rails3::Assist::Directory.rails_root = fixtures_dir
+  end
+
+  it "should find view file using args" do
+    simple_path = 'views/person/show.erb.html'
+    admin_path = 'views/person/admin/show.erb.html'
+    
+    person_show = simple_path_expr(simple_path)
+    person_admin_show = simple_path_expr(admin_path)
+    
+    view_file(:person => :show).should match person_show
+    view_file(:person => 'show').should match person_show
+    view_file('person/admin/' => 'show').should match person_admin_show
+
+    view_file(:person, :show).should match person_show
+    view_file('person/admin', :show).should match person_admin_show
+    view_file(:show, :folder => 'person').should match person_show
+    view_file(:folder => 'person', :action => :show).should match person_show
+    view_file(:folder => 'person', :action => :show, :type => :erb).should match person_show
+  end 
+end    

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-05 00:00:00 +02:00
+date: 2010-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,15 +23,14 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 2
         - 0
         - 0
-        - beta
-        - 22
-        version: 2.0.0.beta.22
+        - rc
+        version: 2.0.0.rc
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,15 +39,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 2
         - 0
         - 0
-        - beta
-        - 22
-        version: 2.0.0.beta.22
+        - rc
+        version: 2.0.0.rc
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -162,6 +160,7 @@ files:
 - lib/rails3_artifactor/rspec/configure.rb
 - rails3_artifactor.gemspec
 - spec/fixtures.rb
+- spec/fixtures/app/views/account/edit.erb.html
 - spec/fixtures/app/views/account/edit.html.erb
 - spec/rails3_artifactor/artifact/base_spec.rb
 - spec/rails3_artifactor/artifact/crud/controller_spec.rb
@@ -173,7 +172,7 @@ files:
 - spec/rails3_artifactor/artifact/crud/observer_spec.rb
 - spec/rails3_artifactor/artifact/crud/permit_spec.rb
 - spec/rails3_artifactor/artifact/crud/view_controller_action_spec.rb
-- spec/rails3_artifactor/artifact/crud/view_controller_default_action_spec.rb
+- spec/rails3_artifactor/artifact/crud/view_file_spec.rb
 - spec/rails3_artifactor/artifact/file_name/artifacts_spec.rb
 - spec/rails3_artifactor/artifact/file_name/migration_spec.rb
 - spec/rails3_artifactor/artifact/file_name/view_spec.rb
@@ -234,7 +233,7 @@ test_files:
 - spec/rails3_artifactor/artifact/crud/observer_spec.rb
 - spec/rails3_artifactor/artifact/crud/permit_spec.rb
 - spec/rails3_artifactor/artifact/crud/view_controller_action_spec.rb
-- spec/rails3_artifactor/artifact/crud/view_controller_default_action_spec.rb
+- spec/rails3_artifactor/artifact/crud/view_file_spec.rb
 - spec/rails3_artifactor/artifact/file_name/artifacts_spec.rb
 - spec/rails3_artifactor/artifact/file_name/migration_spec.rb
 - spec/rails3_artifactor/artifact/file_name/view_spec.rb

data/spec/rails3_artifactor/artifact/crud/view_controller_default_action_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-
-describe 'view' do
-  use_helpers :view
-
-  before :each do              
-    Rails3::Assist::Directory.rails_root = fixtures_dir
-
-    remove_view :account if has_view? :account
-
-    create_view :account do
-      %q{  def index
-  end}
-    end    
-  end
-
-  after :each do              
-    # remove_view :account
-  end
-    
-  it "should have an account_view file that contains an index method and two inserted comments" do
-    insert_into_view :account, :content => '# hello', :before => 'def'
-    insert_into_view :account, :before => 'def' do
-      '# goodbye'
-    end
-    puts read_view(:account)
-    read_view(:account).should have_comment 'hello'
-
-    # root_dir.should have_view :account do |view_file|
-    #   view_file.should have_method :index
-    #   view_file.should have_comment 'hello'
-    #   view_file.should have_comment 'goodbye'
-    # end
-  end
-end