rails_artifactor 0.3.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.rspec

@@ -0,0 +1 @@
+--format nested --color

data/DESIGN_NOTES.textile

@@ -0,0 +1,33 @@
+h1. Version 2
+
+h2. Orm
+
+The macros should allow setting a default :orm, but always allow to specify the orm to use for a particular context.
+
+h2. Template language
+
+The macros should allow setting a default :template language (Tlang), but always allow to specify the Tlang to use for a particular context.
+
+h2. Contexts
+
+<pre>
+with :orm => :mongoid, :template_lang => :erb do |app|
+  app.create_model 'User::Guest' do |model|
+    model.add_field :name, :type => :string, :required => true
+    model.add_method :get_stuff, :params => [:a, :b] do
+      '@a = a'
+    end
+    model.add_code do 
+%q{
+  def hello options = {}
+    puts "hi"
+  end
+}
+    end
+  end
+
+  app.create_model 'User::Guest' do |model|
+    model.add_field :name, :type => :string, :required => true
+  end
+end   
+</pre>

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+source 'http://gems.github.com/'
+
+# group :default do
+#   gem "require_all",        "~> 1.2.0"
+#   gem "sugar-high",         "~> 0.3.6"
+#   gem "activesupport",      "~> 3.0.4"  
+#   gem 'rails_assist',      ">= 0.3.7"
+# end
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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.markdown

@@ -0,0 +1,71 @@
+# Rails3 Artifactor
+
+DSL for operating on various types of Rails 3 application artifacts. The DSL mostly allows performing common CRUD operations etc.
+This is particularly useful when creating Rails 3 generators, plugins etc. that perform code checks and mutations of the app.
+The artifactor has in part been designed for use with the *please me* tool. (see my github account)
+
+## Install
+
+<code>gem install rails_artifactor</code>
+
+## Status
+
+* Specs pass
+* Still needs some refactoring to tidy it up!
+
+## Usage
+
+Introduces the ability to easily load one or more artifact helper modules into your class or module of choice.
+This will introduce various helper methods geared toward operating a that particular kind of artifact, such as CRUD operations etc.
+
+<pre>
+module MyCoolModule  
+  use_helpers :model, :controller
+  use_orm :mongoid
+  
+  def make_hello_model  
+    # this is a method available after loading the :model artifact helper
+    # since orm used is set to :mongoid, it will create a mongoid model file
+    create_model :hello do
+     '# Hello'
+    end
+    
+    remove_model :hello if has_model? :hello
+    
+    create_controller :hello do
+      ...
+    end
+  end
+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:
+<pre>
+  with_model :account do |m|
+    m.create! do
+     '# hello'
+    end
+    
+    m.remove!    
+  end
+</pre>
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails_artifactor"
+  gem.summary = %Q{Helpers for handling Rails 3 artifacts}
+  gem.description = %Q{Helpers for handling Rails 3 artifacts in general, such as CRUD operations etc.}
+  gem.email = "kmandrup@gmail.com"
+  gem.homepage = "http://github.com/kristianmandrup/rails_artifactor"
+  gem.authors = ["Kristian Mandrup"]
+
+  gem.add_development_dependency  "generator-spec",   '>= 0.7.3'
+  
+  # gem.add_dependency              'migration_assist', "~> 0.1.7"
+  gem.add_dependency              "sugar-high",       "~> 0.4.0"  
+  gem.add_dependency              'rails_assist',     "~> 0.4.1"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_assist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+

data/VERSION

@@ -0,0 +1 @@
+0.3.3

data/lib/rails_artifactor/artifact/base.rb

@@ -0,0 +1,59 @@
+module RailsAssist
+  module BaseHelper
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        include RailsAssist::App
+        # include ::Thor::Actions
+      end
+    end
+
+    module ClassMethods
+      def multi_aliases_for name
+        multi_alias :_after_ => name, :create => :new, :insert_into => [:inject_into, :update], :read => :X_content, :remove => :delete                    
+      end
+    end
+                 
+    protected
+
+    def get_type options = {}
+      case options
+      when Hash
+        raise ArgumentError, "No artifact type specified #{options}" if !options[:type]
+        options[:type].to_sym
+      when String, Symbol
+        options.to_sym
+      else
+        raise ArgumentError, "Bad artifact type specified #{options}"        
+      end
+    end
+    
+    def debug?      
+      RailsAssist.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_option name, options={}      
+      type = last_option(options)[:type]
+      marker_content = if type
+        method = :"#{type}_marker"
+        orm_marker = send method, name, options if respond_to? method 
+      else
+        name.to_s.camelize
+      end 
+      options[:before] ? {:before => marker_content} : {:after => marker_content}      
+    end
+  end
+end   

data/lib/rails_artifactor/artifact/crud/create.rb

@@ -0,0 +1,12 @@
+module RailsAssist::Artifact
+  RailsAssist.artifacts.each do |name|
+    plural_name = name.to_s.pluralize
+    class_eval %{
+      module #{name.to_s.camelize}
+        def create_#{name} name, options={}, &block
+          create_artifact(name, set(options, :#{name}), &block)
+        end          
+      end
+    }
+  end
+end

data/lib/rails_artifactor/artifact/crud/delete.rb

@@ -0,0 +1,34 @@
+module RailsAssist::Artifact
+  RailsAssist.artifacts.each do |name|
+    plural_name = name.to_s.pluralize
+    class_eval %{
+      module #{name.to_s.camelize}         
+        def remove_#{name} name
+          remove_artifact name, :#{name}
+        end
+    
+        def remove_#{plural_name} *names      
+          remove_artifacts :#{name}, *names
+        end  
+        
+        def remove_all_#{plural_name}
+          RailsAssist::Artifact::Files.#{name}_files.each do |file_name| 
+            ::File.delete_file! file_name if ::File.file?(file_name)
+          end
+        end
+        alias_method :delete_all_#{plural_name}, :remove_all_#{plural_name}           
+    
+        def remove_#{plural_name} *names
+          return remove_all_#{plural_name} if names.empty? 
+          names.to_strings.each do |name|
+            file_name = #{name}_file(name)
+            ::File.delete!(file_name) if file_name && ::File.file?(file_name)
+          end
+        end
+        alias_method :delete_#{plural_name}, :remove_#{plural_name} 
+        alias_method :remove_#{name}, :remove_#{plural_name} 
+        alias_method :delete_#{name}, :remove_#{plural_name}      
+      end
+    }
+  end
+end

data/lib/rails_artifactor/artifact/crud/read.rb

@@ -0,0 +1,47 @@
+module RailsAssist::Artifact
+  RailsAssist.artifacts.each do |name|
+    plural_name = name.to_s.pluralize
+    class_eval %{
+      module #{name.to_s.camelize}
+        def has_#{plural_name}? *names
+          names.to_strings.each do |name|
+            return false if !has_#{name}? name
+          end
+          true
+        end
+        alias_method :#{plural_name}_files?, :has_#{plural_name}?
+
+        def has_#{name}? name, &block
+          begin
+            found = existing_file_name(name, :#{name}).path.file?
+          rescue IOError
+            found = false
+          end
+          yield if block && found
+          found
+        end
+        alias_method :has_#{name}_file?, :has_#{name}?
+        alias_method :#{name}_file?, :has_#{name}?
+
+
+        def read_#{name}(name, options={}, &block)
+          begin
+            read_artifact(name, set(options, :#{name}), &block)
+          rescue
+            nil
+          end
+        end
+
+        def #{name}_file name, &block
+          begin
+            found = existing_file_name(name, :#{name}).path
+            yield found if block && found
+            found
+          rescue
+            nil
+          end
+        end
+      end
+    }
+  end
+end

data/lib/rails_artifactor/artifact/crud/update.rb

@@ -0,0 +1,25 @@
+module RailsAssist::Artifact
+  RailsAssist.artifacts.each do |name|
+    plural_name = name.to_s.pluralize
+    class_eval %{
+      module #{name.to_s.camelize}         
+        def replace_in_#{name} name, options={}, &block
+          replace_in_artifact(name, set(options, :#{name}), &block)
+        end 
+
+        def replace_in_#{plural_name} *names, &block
+          replace_in_artifacts *names, &block
+        end
+      
+        def insert_into_#{name}(name, options={}, &block)
+          begin
+            insert_into_artifact(name, set(options, :#{name}), &block)      
+            true
+          rescue
+            nil
+          end
+        end
+      end
+    }
+  end
+end

data/lib/rails_artifactor/artifact/crud.rb

@@ -0,0 +1,32 @@
+require 'sugar-high/file'
+require_all File.dirname(__FILE__) + '/crud'
+
+module RailsAssist::Artifact
+  (RailsAssist.artifacts - [:model]).each do |name|
+    class_eval %{
+      module #{name.to_s.camelize}
+        def new_#{name}_content name, content=nil, options = {}, &block
+          options = options.merge(:type => :#{name}, :content => content)
+          new_artifact_content name, options, &block
+        end
+      end
+    }
+  end
+
+  RailsAssist.artifacts.each do |name|
+    plural_name = name.to_s.pluralize
+    class_eval %{
+      module #{name.to_s.camelize}
+        include RailsAssist::BaseHelper
+        
+        def self.included base
+          base.class_eval do              
+            include RailsAssist::Artifact::CRUD        
+          end
+        end
+                
+        multi_aliases_for :#{name}            
+      end
+    }
+  end    
+end

data/lib/rails_artifactor/artifact/file_name/artifacts.rb

@@ -0,0 +1,21 @@
+require 'migration_assist'
+require 'rails_artifactor/base/file_name'
+
+module RailsAssist::Artifact
+  (RailsAssist.artifacts - [:migration, :view]).each do |name|
+    class_eval %{
+      module #{name.to_s.camelize}
+        module FileName
+          include RailsAssist::Artifact::FileName
+      
+          def #{name}_file_name name, options=nil
+            artifact_path name, :#{name}, options
+          end        
+        end
+
+        extend FileName
+        include FileName
+      end
+    }
+  end
+end  

data/lib/rails_artifactor/artifact/file_name/migration.rb

@@ -0,0 +1,54 @@
+require 'migration_assist'
+require 'sugar-high/regexp'
+
+module RailsAssist::Artifact
+  module Migration
+    module FileName 
+      include ::RailsAssist::Migration::ClassMethods
+
+      DIR = RailsAssist::Artifact::Directory
+
+      class FindError
+        attr_accessor :find_expr
+      
+        def initialize find_expr
+          self.find_expr = find_expr
+        end
+      end
+    
+      def migration_file_name name, options={}
+        number = options[:number]              
+      
+        migration_dir_name = File.expand_path(DIR.migration_dir(options))
+              
+        number = next_migration_number(migration_dir_name) if !number      
+        File.join(migration_dir_name, "#{number}_#{name}.rb")      
+      end
+          
+      def find_migration name, options={}
+        root_path = options[:root_path]        
+           
+        migration_dir_name = File.expand_path(DIR.migration_dir options)
+
+        migration_find_expr = "#{migration_dir_name}/[0-9]*_*.rb"
+        migrations = Dir.glob(migration_find_expr)
+      
+        find_err = FindError.new migration_find_expr
+      
+        return find_err if migrations.empty?  
+      
+        migration_find_expr = /\d+_#{name}\.rb$/
+        find_err.find_expr = migration_find_expr
+          
+        matching_migrations = migrations.grep_it(migration_find_expr)
+
+        return find_err if matching_migrations.empty?
+
+        migration_file = (options[:last]) ? matching_migrations.last : matching_migrations.first
+      end      
+    end  
+
+    include FileName 
+    extend FileName     
+  end
+end

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

@@ -0,0 +1,172 @@
+module RailsAssist::Artifact
+  module View    
+    module FileName
+      DIR = RailsAssist::Artifact::Directory
+
+      module Helper
+        def default_template_lang 
+          get_type :erb
+        end
+
+        def get_type type
+          case type.to_s
+          when 'erb'
+            'html.erb'
+          when 'haml'
+            'html.haml'
+          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
+
+      def view_file_name *args
+        folder, action, type = get_view_args(args)
+        options = last_option args
+        root_path = options[:root_path]
+        views_path = options[:views_path]
+        views_path ||= File.join(root_path, 'app/views') if root_path
+        # puts "views: #{views_path}"
+        File.expand_path File.join(views_path || DIR.view_dir, folder.to_s, "#{action}.#{type}")
+      end 
+      
+      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
+          TwoArgs.get_view_args *args 
+        end 
+      end
+    end 
+
+    module SingleArg
+      def self.get_view_args *args
+        args = args.flatten
+        arg = args.first
+        case arg
+        when Hash
+          # 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 RailsAssist::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
+      end
+
+      module HashArgs
+        extend RailsAssist::Artifact::View::FileName::Helper
+
+        DIR = RailsAssist::Artifact::Directory
+        
+        # view_file(:folder => 'person', :action => :show, :type => :erb).should == /views\/person\/show\.html\.erb/         
+        def self.get_view_args hash
+          try_folder = hash.keys.first
+          try_view_folder = File.expand_path(File.join(DIR.view_dir, try_folder.to_s))
+          if File.directory? try_view_folder
+            folder = try_folder          
+            action = hash.values.first
+          else
+            folder = hash[:folder]          
+            action = hash[:action]
+          end            
+          type = get_view_type(hash[:type])
+          [folder, action, type]
+        end
+      end
+
+      module StringArg
+        extend RailsAssist::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]
+        res = 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 RailsAssist::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 RailsAssist::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
+  end
+end