rails3_assist 0.2.2

data/lib/rails3_assist/artifact/view.rb

@@ -0,0 +1,67 @@
+module Rails::Assist
+  module View
+    include Rails::Assist::BaseHelper
+    
+    # CREATE
+    def create_view name, options = {}, &block
+      file = view_file_name(name, options[:action], options[:type])
+      dir = File.dirname(file)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+      content = options[:content]
+      # set content to block
+      content ||= yield if block
+
+      # abort if no content given
+      return if !content    
+      
+      # write file content of view
+      File.open(file, 'w') do |f|  
+        f.puts content 
+      end
+    end  
+
+    # READ
+    def read_view(name, options = {}, &block)
+      file_name = view_file_name(name, options[:action], options[:type])
+      debug "reading from: #{file_name}"
+      file = File.new(file_name)
+      raise "The view file: #{file} could not be found" if !file
+      begin
+        content = file.read
+        debug "read content: #{content}"
+        yield content if block
+        content
+      rescue
+        nil
+      end
+    end
+    
+
+    # UPDATE
+    def insert_into_view(name, options = {}, &block)
+      debug "insert_into_view: #{options}"
+      file = view_file_name(name, options[:action], options[:type])
+      debug "file insertion (view): #{file}"
+      marker = options[:before] || options[:after]
+      file_insertion(file, marker, options, &block) if marker
+    end
+
+    # DELETE
+    def remove_view name, action=nil, type=nil
+      file = view_file_name(name, action, type)
+      FileUtils.rm_f(file) if File.exist?(file)
+    end
+
+    def get_action action
+      action || 'show'
+    end
+
+    def get_type type
+      type || 'html.erb'
+    end
+    
+    include FileName
+
+    aliases_for :view 
+  end
+end

data/lib/rails3_assist/base/class_methods.rb

@@ -0,0 +1,11 @@
+module Rails::Assist
+  module BaseHelper
+    module ClassMethods
+      def aliases_for name
+        multi_alias name, 
+                    :create => :new, :insert_into => [:inject_into, :update], :read => :X_content, :remove => :delete, 
+                    :options => :after
+      end
+    end
+  end
+end

data/lib/rails3_assist/base/create.rb

@@ -0,0 +1,48 @@
+module Rails::Assist
+  module BaseHelper
+    def new_artifact_content name, type, content=nil, &block
+      content ||= yield if block
+      %Q{class #{marker(name, type)}
+  #{content}
+end}
+    end    
+             
+    # CREATE
+    def create_artifact name, options={}, &block
+      type = get_type(options)
+
+      file = make_file_name name, type
+      return if File.exist?(file)
+
+      debug "create #{type}: #{name}, opt: #{options}"
+      debug "file: #{file}"
+
+      # make dir        
+      dir = File.dirname(file)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+
+      content = options[:content]
+      content ||= yield if block
+
+      content_method = :"new_#{type}_content"
+      debug "inner content: #{content}, to inject using ##{content_method}"
+
+      raise "Content method #{content_method} not found #{orm_notify}" if !respond_to?(content_method)
+
+      insert_content = if type == :model        
+        send content_method, name, options.merge(:content => content), &block
+      else
+        send content_method, name, content, &block
+      end
+      
+      debug "content to insert: #{insert_content}"
+
+      return if insert_content.blank?
+
+      File.open(file, 'w') do |f|  
+        f.puts insert_content
+      end
+      debug "file created and content inserted"
+    end
+  end
+end

data/lib/rails3_assist/base/file_name.rb

@@ -0,0 +1,17 @@
+module Rails::Assist
+  module BaseHelper         
+    include Rails::Assist::ArtifactPath
+
+    def make_file_name name, type, options={}      
+      send :"#{type}_file_name", name, options
+    end
+
+    def existing_file_name name, type 
+      # first try finder method
+      finder_method = :"find_#{type}"
+      found = send finder_method, name if respond_to? finder_method      
+      # default
+      make_file_name(name, type) if !found
+    end
+  end
+end

data/lib/rails3_assist/base/insert.rb

@@ -0,0 +1,53 @@
+module Rails::Assist
+  module BaseHelper         
+    # UPDATE
+    def insert_content(name, options={}, &block)
+      type = get_type(options)
+      file = existing_file_name(name, type)  
+      x_marker = marker(name, type, options)
+      res = file_insertion file, x_marker, options, &block
+      if !res
+        # try with :embedded option if default doesn't work
+        x2_marker = marker(name, type, options.merge(:model_type => :embedded))
+        file_insertion file, x2_marker, options, &block        
+      end
+    end
+
+    protected
+
+    def file_insertion(file_name, marker, options={}, &block)
+      return nil if !marker
+
+      file = File.new(file_name)
+      return nil if !File.exist?(file)
+
+      insert_content = options[:content] || (yield if block)
+
+      # already inserted?
+      return nil if insert_content.blank? || (file.read =~ /#{insert_content}/)
+
+      place = options[:before] ? :before : :after 
+
+      debug "insert #{place}: '#{marker}'"
+      debug "content: #{insert_content}"
+      
+      return nil if !(File.new(file.path).read =~ /#{Regexp.escape(marker)}/)
+      
+      mutate_file file.path, marker, place do
+         insert_content
+       end
+     end   
+
+     def mutate_file file, marker, place, &block
+       raise ArgumentError, "You must define a replacement marker for a :before or :after key" if !marker 
+       replace_in_file file, /(#{Regexp.escape(marker)})/mi do |match|
+         place == :after ? "#{match}\n  #{yield}" : "#{yield}\n  #{match}"         
+       end
+     end  
+     
+     def replace_in_file(path, regexp, *args, &block)
+       content = File.read(path).gsub(regexp, *args, &block)
+       File.open(path, 'wb') { |file| file.write(content) }
+     end    
+  end
+end

data/lib/rails3_assist/base/read.rb

@@ -0,0 +1,19 @@
+module Rails::Assist
+  module BaseHelper         
+    # READ
+    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_assist/base/remove.rb

@@ -0,0 +1,14 @@
+module Rails::Assist
+  module BaseHelper
+
+    # DELETE
+    def remove_artifact name, type
+      file = make_file_name name, type
+      debug "removed artifact: #{name}" if File.exist?(file) && FileUtils.rm_f(file) 
+    end
+
+    def remove_artifacts type,*names
+      names.flatten.each{|name| send :"remove_#{type}", name }
+    end
+  end
+end

data/lib/rails3_assist/base.rb

@@ -0,0 +1,49 @@
+module Rails::Assist
+  module BaseHelper
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        include Rails::Assist::App
+        include ::Thor::Actions
+      end
+    end
+                 
+    protected
+
+    def get_type options = {}
+      case options
+      when Hash
+        raise ArgumentError, "No artifact type specified #{options}" if !options[:type]
+        options[:type]
+      when String, Symbol
+        options.to_sym
+      else
+        raise ArgumentError, "Bad artifact type specified #{options}"        
+      end
+    end
+    
+    def debug?      
+      Rails::Assist.debug_on
+    end    
+
+    def debug msg
+      puts msg if debug?
+    end
+
+    def set options, type
+      options.merge!(:type => type)
+      options
+    end
+
+    def orm_notify
+      ''
+    end
+
+    def marker name, type, options={}      
+      return send :"#{type}_marker", name, options if type
+      name.to_s.camelize
+    end
+  end
+end   
+
+require_all File.dirname(__FILE__) + '/base'

data/lib/rails3_assist/extensions/core_ext.rb

@@ -0,0 +1,29 @@
+class Module
+  def multi_alias name, options={}
+    config_options = options[:options]
+    options.each_pair do |original, aliases|
+      next if original == :options 
+      alias_methods name, original, [aliases].flatten, config_options
+    end            
+  end
+
+  protected
+
+  def alias_methods name, original, aliases, config_options
+    aliases.each do |alias_name| 
+      new_alias     = make_name(name, alias_name.to_s, config_options)
+      original_name = make_name(name, original.to_s, config_options)
+      alias_method new_alias, original_name if respond_to? original_name
+    end
+  end
+
+  def make_name name, alias_name, config_options
+    return alias_name.gsub(/X/, name.to_s) if alias_name =~ /X/
+    case config_options
+    when :after
+      "#{alias_name}_#{name}"
+    when :before
+      "#{name}_#{alias_name}"
+    end
+  end
+end

data/lib/rails3_assist/rspec/macro.rb

@@ -0,0 +1,34 @@
+module Rails::Assist
+  module UseMacro
+    def use_orm orm
+      class_eval do
+        begin
+          include "Rails::Assist::Orm::#{orm.to_s.camelize}".constantize
+        rescue
+          raise ArgumentError, "Unregistered ORM library: #{orm}"
+        end
+      end
+    end
+  
+    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 "Rails::Assist::#{type.to_s.camelize}".constantize
+        rescue
+          raise ArgumentError, "Unregistered Rails3 helper library: #{type}"
+        end
+      end
+    end 
+    alias_method :load_helper, :use_helper
+  end                         
+end
+                              
+RSpec.configure do |config|
+  config.extend(Rails::Assist::UseMacro) 
+end

data/lib/rails3_assist.rb

@@ -0,0 +1,21 @@
+require 'thor'
+require 'require_all'
+require 'active_support/inflector'
+
+module Rails
+  module Assist
+    def self.artifacts
+      [:observer, :controller, :helper, :mailer, :model, :migration]
+    end  
+    
+    class << self
+      attr_accessor :debug_on
+    end    
+  end
+end
+
+require 'rails3_assist/extensions/core_ext'
+require 'rails3_assist/rspec/macro'
+require 'rails3_assist/app'
+require_all File.dirname(__FILE__) + '/rails3_assist/artifact'
+

data/rails3_assist.gemspec

@@ -0,0 +1,107 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails3_assist}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-08-19}
+  s.description = %q{Assist in operating on Rails 3 artifacts including migrations}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/rails3_assist.rb",
+     "lib/rails3_assist/app.rb",
+     "lib/rails3_assist/app/file_names.rb",
+     "lib/rails3_assist/app/methods/crud.rb",
+     "lib/rails3_assist/app/methods/new_content.rb",
+     "lib/rails3_assist/app/rails_dirs.rb",
+     "lib/rails3_assist/app/rails_files.rb",
+     "lib/rails3_assist/artifact/markers.rb",
+     "lib/rails3_assist/artifact/migration.rb",
+     "lib/rails3_assist/artifact/orm.rb",
+     "lib/rails3_assist/artifact/view.rb",
+     "lib/rails3_assist/base.rb",
+     "lib/rails3_assist/base/class_methods.rb",
+     "lib/rails3_assist/base/create.rb",
+     "lib/rails3_assist/base/file_name.rb",
+     "lib/rails3_assist/base/insert.rb",
+     "lib/rails3_assist/base/read.rb",
+     "lib/rails3_assist/base/remove.rb",
+     "lib/rails3_assist/extensions/core_ext.rb",
+     "lib/rails3_assist/rspec/macro.rb",
+     "rails3_assist.gemspec",
+     "rails_generator.log",
+     "spec/load_spec.rb",
+     "spec/rails3_assist/app/app_dirs_spec.rb",
+     "spec/rails3_assist/app/app_file_names_spec.rb",
+     "spec/rails3_assist/app/app_files_spec.rb",
+     "spec/rails3_assist/artifact/controller/controller_spec.rb",
+     "spec/rails3_assist/artifact/helper/helper_spec.rb",
+     "spec/rails3_assist/artifact/mailer/mailer_spec.rb",
+     "spec/rails3_assist/artifact/migration/migration_spec.rb",
+     "spec/rails3_assist/artifact/model/model_spec.rb",
+     "spec/rails3_assist/artifact/observer/observer_spec.rb",
+     "spec/rails3_assist/artifact/orm/active_record_spec.rb",
+     "spec/rails3_assist/artifact/orm/mongo_mapper_spec.rb",
+     "spec/rails3_assist/artifact/orm/mongoid_spec.rb",
+     "spec/rails3_assist/artifact/view_spec/view_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/rails3-assist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Assist in operating on Rails 3 artifacts including migrations}
+  s.test_files = [
+    "spec/load_spec.rb",
+     "spec/rails3_assist/app/app_dirs_spec.rb",
+     "spec/rails3_assist/app/app_file_names_spec.rb",
+     "spec/rails3_assist/app/app_files_spec.rb",
+     "spec/rails3_assist/artifact/controller/controller_spec.rb",
+     "spec/rails3_assist/artifact/helper/helper_spec.rb",
+     "spec/rails3_assist/artifact/mailer/mailer_spec.rb",
+     "spec/rails3_assist/artifact/migration/migration_spec.rb",
+     "spec/rails3_assist/artifact/model/model_spec.rb",
+     "spec/rails3_assist/artifact/observer/observer_spec.rb",
+     "spec/rails3_assist/artifact/orm/active_record_spec.rb",
+     "spec/rails3_assist/artifact/orm/mongo_mapper_spec.rb",
+     "spec/rails3_assist/artifact/orm/mongoid_spec.rb",
+     "spec/rails3_assist/artifact/view_spec/view_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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.19"])
+      s.add_runtime_dependency(%q<require_all>, [">= 1.1.0"])
+      s.add_runtime_dependency(%q<migration_assist>, [">= 0.1.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<require_all>, [">= 1.1.0"])
+      s.add_dependency(%q<migration_assist>, [">= 0.1.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<require_all>, [">= 1.1.0"])
+    s.add_dependency(%q<migration_assist>, [">= 0.1.2"])
+  end
+end
+

data/rails_generator.log

@@ -0,0 +1,14 @@
+-----------------------------------------------------
+2010-08-18 13:38:04 +0200 -- setup generator: [basic_generator]
+[BasicGenerator]
+-- By default we are in info mode...
+This is debugging mode!
+-- Back to info mode
+-----------------------------------------------------
+2010-08-18 13:40:00 +0200 -- setup generator: [basic_generator]
+[BasicGenerator]
+-- By default we are in info mode...
+-- debug lv set to: debug
+This is debugging mode!
+-- More info... but still in debugging mode
+-- Back to info mode

data/spec/load_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/rails3_assist/app/app_dirs_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'controller' do
+  use_helper :app
+
+  before do                                         
+    Rails::Assist::App.rails_root_dir = temp_dir('tmp_rails')
+  end
+
+  after do
+    remove_temp_dir 'tmp_rails'
+  end
+    
+  it "should create basic root directories" do
+    create_empty_tmp root_directories    
+    root_dir.should have_dirs root_directories
+  end
+
+  it "should have basic app directories" do
+    create_empty_tmp app_artifacts
+    app_dir.should have_dirs app_directories
+  end
+end

data/spec/rails3_assist/artifact/controller/controller_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'controller' do
+  use_helpers :app, :controller
+
+  before :each do
+    remove_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_assist/artifact/helper/helper_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'helper' do
+  use_helpers :app, :helper
+
+  before :each do              
+    remove_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_assist/artifact/mailer/mailer_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'mailer' do
+  use_helpers :app, :mailer
+
+  before :each do              
+    remove_mailer :account        
+    create_mailer :account do
+      %q{
+        def index
+        end
+      }
+    end    
+  end
+
+  after :each do              
+    # remove_mailer :account
+  end
+    
+  it "should have an account_mailer file that contains an index method and two inserted comments" do
+    insert_into_mailer :account, :content => '# hello'
+    insert_into_mailer :account do
+      '# goodbye'
+    end
+    read_mailer(:account).should have_comment 'hello'
+    puts read_mailer(:account)
+    # root_dir.should have_mailer :account do |mailer_file|
+    #   mailer_file.should have_method :index
+    #   mailer_file.should have_comment 'hello'
+    #   mailer_file.should have_comment 'goodbye'
+    # end
+  end
+end

data/spec/rails3_assist/artifact/migration/migration_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'migration' do
+  use_helpers :app, :migration
+
+  before :each do              
+    remove_migration :create_account        
+    
+    create_migration :create_account do
+      %q{
+        def index
+        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)
+    # root_dir.should have_migration :create_account do |migration_file|
+    #   migration_file.should have_method :index
+    #   migration_file.should have_comment 'hello'
+    #   migration_file.should have_comment 'goodbye'
+    # end
+  end
+end