rails3_artifactor 0.1.0

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

@@ -0,0 +1,14 @@
+module Rails3::Assist::Artifact::CRUD
+  module Delete
+    def remove_artifact name, type
+      file = existing_file_name name, type
+      debug "removed artifact: #{name}" if File.exist?(file) && FileUtils.rm_f(file) 
+    end
+    alias_method :delete_artifact, :remove_artifact
+
+    def remove_artifacts type,*names
+      names.flatten.each{|name| send :"remove_#{type}", name }
+    end
+    alias_method :delete_artifacts, :remove_artifacts    
+  end
+end

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

@@ -0,0 +1,20 @@
+module Rails3::Assist::Artifact::CRUD
+  module Read        
+    
+    # TODO: Support :before and :after hash options!
+    def read_artifact(name, options, &block)
+      type = get_type(options)
+      file_name = existing_file_name(name, type)
+      debug "reading from: #{file_name}"
+      begin
+        file = File.new(file_name)
+        content = file.read
+        debug "read content: #{content}"
+        yield content if block
+        content
+      rescue
+        raise "Rails #{type} at: #{file_name} can't be read"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'sugar-high/arguments'
+
+module Rails3::Assist::Artifact::CRUD
+  module Update
+    def insert_into_artifact name, options={}, &block
+      type = get_type(options)
+      file = existing_file_name(name, type)
+
+      raise "No file could be determined: #{file} from name: #{name} of type: #{type}" if !file      
+      raise "File to insert in not found: #{file} for #{type}" if !File.file?(file)
+
+      options1 = options.merge marker_option(name, type, options)
+      
+      res = File.insert_into file, options1, &block
+      if !res
+        # try with :embedded option if default doesn't work
+        mrk_opt = marker_option name, type, options.merge(:model_type => :embedded)
+        options.merge! mrk_opt
+
+        File.insert_into file, options, &block        
+      end
+    end 
+    alias_method :update_artifact, :insert_into_artifact
+    
+    def remove_from_artifact name, options={}, &block
+      # TODO
+    end
+
+    def remove_content_from type, *names, &block
+      replacement_expr = last_option names
+      names.flatten.each do |name|
+        file = existing_file_name(name, type)
+        File.remove_content_from file, replacement_expr=nil, &block
+      end
+    end  
+    
+    # TODO
+    aliases_for :remove_content_from, :delete_content_from, :delete_from, :remove_from
+
+    def replace_in_artifact name, options={}, &block
+      # TODO
+    end
+  end    
+end

data/lib/rails3_artifactor/base/crud.rb

@@ -0,0 +1,6 @@
+require 'sugar-high/includes'
+require_all File.dirname(__FILE__) + '/crud'
+
+module Rails3::Assist::Artifact::CRUD
+  extends_and_includes :create, :read, :update, :delete
+end

data/lib/rails3_artifactor/base/file_name.rb

@@ -0,0 +1,41 @@
+require 'rails3_assist/artifact'
+
+module Rails3::Assist::Artifact
+  module FileName         
+    include Rails3::Assist::Artifact::Directory
+    include Rails3::Assist::Artifact::Path
+
+    def make_file_name name, type, options={}      
+      send :"#{type}_file_name", name, options
+    end
+
+    def existing_file_name name, type=nil 
+      # first try finder method
+      finder_method = :"find_#{type}"       
+      if respond_to?(finder_method)          
+        result = send finder_method, name 
+        if !result.kind_of? String          
+          raise IOError, "The call to #find_#{type}(#{name}) didn't find an existing #{type} file. Error in find expression: #{result.find_expr}" 
+        end
+        return result
+      elsif type == :migration
+        raise "The method #find_#{type} to find the migration is not available!"
+      end
+      
+      # default for non-migration
+      file_name = make_file_name(name, type)      
+      raise IOError, "No file for :#{type} found at location: #{file_name}" if !File.file?(file_name)
+      file_name
+    end
+
+    Rails3::Assist.artifacts.each do |name|
+      class_eval %{
+        def existing_#{name}_file name, type=nil
+          existing_file_name name, type
+        end
+      } 
+    end
+  end  # file_name
+  
+  include FileName
+end    

data/lib/rails3_artifactor/namespaces.rb

@@ -0,0 +1,13 @@
+require 'rails3_assist'
+require 'sugar-high/module'
+
+module Rails3
+  module Assist
+    module Artifact
+      modules :crud
+      modules Rails3::Assist.artifacts do
+        nested_modules :file_name
+      end
+    end
+  end
+end

data/lib/rails3_artifactor/rspec/configure.rb

@@ -0,0 +1,6 @@
+require 'rails3_artifactor/rspec/macro'
+
+RSpec.configure do |config|
+  config.extend Rails3::Assist::UseMacro
+  config.include Rails3::Assist::UseMacro
+end

data/lib/rails3_artifactor/rspec/macro.rb

@@ -0,0 +1,30 @@
+module Rails3::Assist
+  module UseMacro
+    def assist_with *types
+      types.each{|type| use_helper type}
+    end
+    alias_method :load_helpers, :assist_with
+    alias_method :use_helpers,  :assist_with
+
+    def use_helper type
+      class_eval do
+        begin
+          include "Rails3::Assist::Artifact::#{type.to_s.camelize}".constantize
+        rescue
+          raise ArgumentError, "Unregistered Rails3 helper library: #{type}"
+        end
+      end
+    end 
+    alias_method :load_helper, :use_helper
+
+    def use_orm orm
+      class_eval do
+        begin
+          include "Rails3::Assist::Orm::#{orm.to_s.camelize}".constantize
+        rescue
+          raise ArgumentError, "Unregistered ORM library: #{orm}"
+        end
+      end
+    end
+  end
+end

data/lib/rails3_artifactor.rb

@@ -0,0 +1,6 @@
+require 'require_all'
+require 'sugar-high/file'
+require 'sugar-high/alias'
+require 'rails3_assist'
+
+require_all File.dirname(__FILE__) + '/rails3_artifactor'

data/spec/fixtures/app/controllers/account_controller.rb

@@ -0,0 +1,4 @@
+class AccountController < ActionController::Base
+  # hello
+  {:type=>:controller, :content=>"\n        def index\n        end\n      "}
+end

data/spec/fixtures/app/helpers/account_helper.rb

@@ -0,0 +1,4 @@
+class AccountHelper
+  # hello
+  {:type=>:helper, :content=>"\n        def index\n        end\n      "}
+end

data/spec/fixtures/app/models/account.rb

@@ -0,0 +1,5 @@
+class Account
+  # hello
+  def index
+  end
+end

data/spec/fixtures/app/models/account_observer.rb

@@ -0,0 +1,4 @@
+class AccountObserver < ActiveRecord::Observer
+  # hello
+  {:type=>:observer, :content=>"\n        def index\n        end\n      "}
+end

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

@@ -0,0 +1,4 @@
+
+        # hello
+  <h1><%= title %></h1>
+      

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

@@ -0,0 +1,3 @@
+  # hello
+  def index
+  end

data/spec/fixtures/db/migrations/20100904095012_create_account.rb

@@ -0,0 +1,4 @@
+class CreateAccount < ActiveRecord::Migration
+  # hello
+  {:type=>:migration, :content=>"\n        def self.up\n        end\n\n        def self.down\n        end\n      "}
+end

data/spec/fixtures.rb

@@ -0,0 +1,3 @@
+def fixtures_dir
+  File.dirname(__FILE__) + '/fixtures'  
+end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'controller' do
+  use_helpers :controller
+
+  before :each do
+    Rails3::Assist::Directory.rails_root = fixtures_dir
+    
+    remove_controller :account if has_controller? :account        
+    create_controller :account do
+      %q{
+        def index
+        end
+      }
+    end    
+  end
+
+  after :each do              
+    # remove_controller :account
+  end
+    
+  it "should have an account_controller file that contains an index method and two inserted comments" do
+    insert_into_controller :account, :content => '# hello'
+    insert_into_controller :account do
+      '# goodbye'
+    end
+    read_controller(:account).should have_comment 'hello'                                           
+    puts read_controller(:account)
+    # root_dir.should have_controller :account do |controller_file|
+    #   controller_file.should have_method :index
+    #   controller_file.should have_comment 'hello'
+    #   controller_file.should have_comment 'goodbye'
+    # end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'helper' do
+  use_helpers :helper
+
+  before :each do              
+    Rails3::Assist::Directory.rails_root = fixtures_dir
+    
+    remove_helper :account if has_helper? :account        
+    create_helper :account do
+      %q{
+        def index
+        end
+      }
+    end    
+  end
+
+  after :each do              
+    # remove_helper :account
+  end
+    
+  it "should have an account_helper file that contains an index method and two inserted comments" do
+    insert_into_helper :account, :content => '# hello'
+    insert_into_helper :account do
+      '# goodbye'
+    end
+    read_helper(:account).should have_comment 'hello'
+    puts read_helper(:account)
+    # root_dir.should have_helper :account do |helper_file|
+    #   helper_file.should have_method :index
+    #   helper_file.should have_comment 'hello'
+    #   helper_file.should have_comment 'goodbye'
+    # end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+Rails::Migration::Assist.orm = :active_record
+
+describe 'migration' do 
+  use_orm :active_record
+  use_helpers :migration
+
+  before :each do              
+    @root_dir = Rails3::Assist::Directory.rails_root = fixtures_dir
+    
+    remove_migration :create_account if has_migration? :create_account
+    
+    create_migration :create_account do
+      %q{
+        def self.up
+        end
+
+        def self.down
+        end
+      }
+    end    
+  end
+
+  after :each do              
+    # remove_migration :create_account
+  end
+    
+  it "should have an create_account_migration file that contains an index method and two inserted comments" do
+    insert_into_migration :create_account, :content => '# hello'
+    insert_into_migration :create_account do
+      '# goodbye'
+    end
+    read_migration(:create_account).should have_comment 'hello'
+    puts read_migration(:create_account)
+
+    # puts migration_file_name :create_account
+
+    # puts existing_file_name :create_account, :migration
+
+    # @root_dir.should have_migration :create_account
+    # 
+    # lambda {existing_migration_file :blip}.should raise_error
+    # 
+    # @root_dir.should have_migration :create_account do |migration_file|
+    #   migration_file.should have_class_method :up
+    #   migration_file.should have_comment 'hello'
+    #   migration_file.should have_comment 'goodbye'
+    # end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'model without orm' do
+  use_orm :none
+  use_helper :model
+
+  before :each do  
+    Rails3::Assist::Directory.rails_root = fixtures_dir
+    
+    remove_model :account if has_model? :account                
+    create_model :account do
+      %q{def index
+  end}
+    end    
+  end
+
+  after :each do              
+    # remove_model :account
+  end
+    
+  it "should have an account_model file that contains an index method and two inserted comments" do
+    insert_into_model :account, :content => '# hello'
+    insert_into_model :account do
+      '# goodbye'
+    end
+    puts read_model(:account)
+    read_model(:account).should have_comment 'hello'
+
+
+    # root_dir.should have_model :account do |model_file|
+    #   model_file.should have_method :index
+    #   model_file.should have_comment 'hello'
+    #   model_file.should have_comment 'goodbye'
+    # end
+  end
+end
+

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

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'observer' do
+  use_helpers :observer
+
+  before :each do  
+    Rails3::Assist::Directory.rails_root = fixtures_dir    
+                
+    remove_observer :account if has_observer? :account        
+    create_observer :account do
+      %q{
+        def index
+        end
+      }
+    end    
+  end
+
+  after :each do              
+    # remove_observer :account
+  end
+    
+  it "should have an account_observer file that contains an index method and two inserted comments" do
+    insert_into_observer :account, :content => '# hello'
+    insert_into_observer :account do
+      '# goodbye'
+    end
+    read_observer(:account).should have_comment 'hello'
+    puts read_observer(:account)
+
+    # root_dir.should have_observer :account do |observer_file|
+    #   observer_file.should have_method :index
+    #   observer_file.should have_comment 'hello'
+    #   observer_file.should have_comment 'goodbye'
+    # end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe 'view API - symbols' do
+  use_helpers :view
+
+  before :each do              
+    Rails3::Assist::Directory.rails_root = fixtures_dir
+
+    remove_view :account, :edit if has_view? :account, :edit
+    create_view :account, :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, :edit, :content => '# hello', :before => '<h1>'
+    insert_into_view :account, :edit, :before => '<h1>' do
+      '# goodbye'
+    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_controller_default_action_spec.rb

@@ -0,0 +1,35 @@
+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

data/spec/rails3_artifactor/artifact/file_name/artifacts_spec.rb

@@ -0,0 +1,29 @@
+require 'require_all'
+require 'rails3_artifactor/namespaces'
+require 'rails3_artifactor/artifact/file_name/artifacts'
+
+CLASS = Rails3::Assist::Artifact::FileName
+
+class ArtDir
+  include CLASS
+end
+
+describe Rails3::Assist::Artifact::FileName do
+  # use_helper :directories
+
+  before do
+    Rails3::Assist::Directory.rails_root = File.dirname (__FILE__)
+    @test = ArtDir.new
+  end
+
+  (Rails3::Assist.artifacts - [:migration, :view]).each do |name|
+    eval %{
+      describe '##{name}_file_name' do
+        it "should return the file name for #{name}" do
+          clazz = Rails3::Assist::Artifact::#{name.to_s.camelize}
+          clazz.#{name}_file_name('user').should match /user/
+        end
+      end
+    }
+  end
+end

data/spec/rails3_artifactor/artifact/file_name/migration_spec.rb

@@ -0,0 +1,30 @@
+# require 'spec_helper'
+require 'require_all'
+require 'rails3_artifactor/namespaces'
+require 'rails3_artifactor/artifact/file_name/migration'
+require 'rails3_artifactor/artifact/orm'
+require 'rails3_artifactor/rspec/configure'
+
+CLASS = Rails3::Assist::Artifact::Migration
+
+Rails::Migration::Assist.orm = :active_record
+
+class ArtDir
+  include CLASS
+end
+
+describe Rails3::Assist::Artifact::Migration::FileName do
+  # use_orm :active_record
+
+  before do
+    Rails3::Assist::Directory.rails_root = File.dirname (__FILE__)
+    @test = ArtDir.new
+  end
+
+  describe '#migration_file_name' do
+    it "should return the file name for migration" do      
+      CLASS.migration_file_name(:create_persons).should match /create_persons/
+    end
+  end
+end
+

data/spec/rails3_artifactor/artifact/file_name/view_spec.rb

@@ -0,0 +1,27 @@
+# require 'spec_helper'
+require 'require_all'
+require 'sugar-high/regexp'
+require 'rails3_artifactor/namespaces'
+require 'rails3_artifactor/artifact/file_name/view'
+# require 'rails3_artifactor/rspec/configure'
+
+CLASS = Rails3::Assist::Artifact::View
+
+class ArtDir
+  include CLASS
+end
+
+describe Rails3::Assist::Artifact::View::FileName do
+  # use_orm :active_record
+
+  before do
+    Rails3::Assist::Directory.rails_root = File.dirname (__FILE__)
+    @test = ArtDir.new
+  end
+
+  describe '#view_file_name' do
+    it "should return the file name for the persons/show view" do      
+      CLASS.view_file_name(:person, :show).should match 'views/person/show'.to_regexp
+    end
+  end
+end