rails3_artifactor 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

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

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,67 @@
+# 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 rails3_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>
+
+## 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,18 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails3_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/rails3_artifact_helper"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", "~> 2.0.0"
+    gem.add_dependency "require_all", "~> 1.1.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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

@@ -0,0 +1,71 @@
+module Rails3::Assist::Artifact
+  module View
+    include Rails3::Assist::BaseHelper
+
+    def has_view? name, *args, &block
+      file_name = view_file_name(name, args)
+      file_name.path.file?
+    end
+    
+    # CREATE
+    def create_view name, *args, &block
+      file_name = view_file_name(name, args)      
+      dir = File.dirname(file_name)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+
+      content = get_content(args) || yield if block
+      
+      # abort if no content given
+      debug "Warning: Content must be passed in either as a :content hash or a block" if !content
+      return nil if !content
+
+      debug "Writing view file: #{file_name}"
+      # write file content of view
+      File.open(file_name, 'w') do |f|  
+        f.puts content 
+      end
+    end  
+
+    # READ
+    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
+        content = file.read
+        debug "read content: #{content}"
+        yield content if block
+        content
+      rescue
+        nil
+      end
+    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
+    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_content args
+      args = args.flatten
+      case args.first
+      when Hash
+        args.first[:content]
+      end
+    end    
+
+    multi_aliases_for :view 
+  end
+end

data/lib/rails3_artifactor/artifact/crud.rb

@@ -0,0 +1,55 @@
+require 'sugar-high/file'
+require_all File.dirname(__FILE__) + '/crud'
+
+module Rails3::Assist::Artifact
+  (Rails3::Assist.artifacts - [:model]).each do |name|
+    class_eval %{
+      module #{name.to_s.camelize}
+        def new_#{name}_content name, content=nil, &block
+          new_artifact_content name, :#{name}, content, &block
+        end
+      end
+    }
+  end
+
+  Rails3::Assist.artifacts.each do |name|
+    class_eval %{
+      module #{name.to_s.camelize}      
+        include Rails3::Assist::BaseHelper
+        include Rails3::Assist::Artifact::CRUD        
+
+        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
+        
+        def create_#{name} name, options={}, &block
+          create_artifact(name, set(options, :#{name}), &block)
+        end          
+      
+        def insert_into_#{name}(name, options={}, &block)
+          insert_into_artifact(name, set(options, :#{name}), &block)      
+        end
+        
+        def read_#{name}(name, options={}, &block)
+          read_artifact(name, set(options, :#{name}), &block)      
+        end
+
+        def remove_#{name} name
+          remove_artifact name, :#{name}
+        end
+    
+        def remove_#{name}s *names      
+          remove_artifacts :#{name}, *names
+        end              
+        
+        multi_aliases_for :#{name}            
+      end
+    }
+  end    
+end

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

@@ -0,0 +1,21 @@
+require 'migration_assist'
+require 'rails3_artifactor/base/file_name'
+
+module Rails3::Assist::Artifact
+  (Rails3::Assist.artifacts - [:migration, :view]).each do |name|
+    class_eval %{
+      module #{name.to_s.camelize}
+        module FileName
+          include Rails3::Assist::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/rails3_artifactor/artifact/file_name/migration.rb

@@ -0,0 +1,54 @@
+require 'migration_assist'
+require 'sugar-high/regexp'
+
+module Rails3::Assist::Artifact
+  module Migration
+    module FileName 
+      include ::Rails::Migration::Assist::ClassMethods      
+
+      DIR = Rails3::Assist::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[:root_path])
+              
+        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[:root_path])
+
+        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/rails3_artifactor/artifact/file_name/view.rb

@@ -0,0 +1,36 @@
+module Rails3::Assist::Artifact
+  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)
+        File.expand_path File.join(DIR.view_dir, folder.to_s, "#{action}.#{type}")
+      end 
+      
+      def get_view_args args 
+        args = args.flatten
+        action  = DEFAULT_REST_ACTION
+        type    = DEFAULT_TEMPLATE_LANG
+        case args.first
+        when Hash
+          action = args.first.delete(:action)
+          type = args.first.delete(:type)
+        when String, Symbol     
+          action = args.delete_at(0)
+        end
+        case args.first
+        when String, Symbol        
+          type = args.delete_at(0)
+        end      
+        [action || DEFAULT_REST_ACTION, type || DEFAULT_TEMPLATE_LANG, args]
+      end
+    end 
+    
+    include FileName
+    extend FileName
+  end
+end

data/lib/rails3_artifactor/artifact/markers.rb

@@ -0,0 +1,76 @@
+require 'rails3_artifactor/base/class_methods'
+require 'rails3_assist/base'
+
+module Rails3::Assist::Artifact
+  module Marker
+    def marker name, type, options=nil
+      method = "#{type}_marker"  
+      raise "No such marker method in this context: #{self}, ##{method}" if !respond_to? method
+      send method, name, options 
+    end
+  end
+  
+  module Controller
+    def controller_marker name, options=nil
+      "#{name.to_s.camelize}Controller < ActionController::Base"
+    end
+    
+    extend self
+  end
+
+  module Helper   
+    def helper_marker name, options=nil
+      "#{name.to_s.camelize}Helper"
+    end
+
+    extend self
+  end
+
+  module Permit
+    def permit_marker name, options=nil
+      "#{name.to_s.camelize}"
+    end        
+    
+    extend self    
+  end
+  
+  module Mailer
+    def mailer_marker name, options=nil
+      "#{name.to_s.camelize}Mailer < ActionMailer::Base"
+    end
+    
+    extend self    
+  end    
+
+  module Observer
+    def observer_marker name, options=nil
+      "#{name.to_s.camelize}Observer < ActiveRecord::Observer"
+    end
+    
+    extend self
+  end
+
+  module Migration
+    def migration_marker name, options=nil
+      "#{name.to_s.camelize} < ActiveRecord::Migration"
+    end    
+    
+    extend self
+  end
+  
+  module Model   
+    include Rails3::Assist::BaseHelper    
+    
+    def model_marker name, options={}
+      return send :orm_marker_name, options if respond_to?(:orm_marker_name)
+      name.to_s.camelize      
+    end
+    
+    def orm_notify
+      ". You must specify an ORM with the macro use_orm, f.ex -- use_orm :active_record"
+    end 
+    
+    extend self       
+  end
+  
+end

data/lib/rails3_artifactor/artifact/migration.rb

@@ -0,0 +1,11 @@
+require 'migration_assist'
+
+Rails::Migration::Assist.rails_root_dir = Rails3::Assist::Directory.rails_root
+
+module Rails3::Assist::Artifact
+  module Migration
+    include Rails3::Assist::BaseHelper    
+    include Rails::Migration::Assist::ClassMethods
+    include Rails3::Assist::Artifact::FileName
+  end
+end

data/lib/rails3_artifactor/artifact/orm/active_record.rb

@@ -0,0 +1,14 @@
+module Rails3::Assist::Orm
+  module ActiveRecord
+    include Rails3::Assist::Orm::Base
+
+    def orm_marker_name options=nil
+      'ActiveRecord::Base'
+    end
+
+    def new_model_content name, options={}, &block        
+      content = options[:content] || yield if block
+      file_w_inherit(name, orm_marker_name(options)) { content }
+    end
+  end
+end

data/lib/rails3_artifactor/artifact/orm/data_mapper.rb

@@ -0,0 +1,22 @@
+module Rails3::Assist::Orm
+  module DataMapper
+    include Rails3::Assist::Orm::Base
+
+    def orm_name
+      'DataMapper'
+    end
+
+    def orm_marker_name options=nil
+      "#{orm_name}::Resource"
+    end
+
+    def new_model_content name, options={}, &block        
+      content = options[:content] || yield if block
+      file_w_include(name, orm_marker_name(options)) { content }
+    end
+
+    def field_name
+      'property'
+    end
+  end
+end

data/lib/rails3_artifactor/artifact/orm/mongo_mapper.rb

@@ -0,0 +1,18 @@
+module Rails3::Assist::Orm
+  module MongoMapper
+    include Rails3::Assist::Orm::Base
+
+    def orm_name
+      'MongoMapper'
+    end      
+  
+    def new_model_content name, options={}, &block        
+      content = options[:content] || yield if block
+      file_w_include(name, orm_marker_name(options)) { content }
+    end
+
+    def field_name
+      'key'
+    end
+  end
+end

data/lib/rails3_artifactor/artifact/orm/mongoid.rb

@@ -0,0 +1,23 @@
+module Rails3::Assist::Orm
+  module Mongoid
+    include Rails3::Assist::Orm::Base
+
+    def orm_name
+      'Mongoid'
+    end
+
+    def field_name
+      'field'
+    end
+
+    def new_model_content name, options={}, &block        
+      content = options[:content] || yield if block
+      file_w_include(name, orm_marker_name(options)) { content }
+    end
+
+    def field name, type = nil
+      return "#{field_name} :#{name}, :type => #{type}" if type
+      "#{field_name} :#{name}"
+    end
+  end
+end

data/lib/rails3_artifactor/artifact/orm/none.rb

@@ -0,0 +1,17 @@
+require 'active_support/inflector'
+
+module Rails3::Assist::Orm
+  module None
+    include Rails3::Assist::Orm::Base
+
+    def orm_marker_name options=nil
+      @name.to_s.camelize
+    end
+
+    def new_model_content name, options={}, &block        
+      content = block ? yield : options[:content]
+      @name = name
+      simple_file(name, orm_marker_name(options)) { content }
+    end
+  end
+end

data/lib/rails3_artifactor/artifact/orm.rb

@@ -0,0 +1,51 @@
+module Rails3::Assist
+  module Orm
+    module Base
+      # include Rails3::Assist::Artifact::Model 
+
+      protected
+
+      def orm_marker_name options = {:model_type => :document}
+        document_name options
+      end
+
+      def document_name options = {:model_type => :document} 
+        type_content = options[:model_type] == :embedded ?  "#{orm_name}::EmbeddedDocument" : "#{orm_name}::Document"
+      end
+
+      def clazz name
+        "class #{name.to_s.camelize}"
+      end
+
+      def file name, include_stmt, &block
+        %Q{#{clazz name}
+  #{include_stmt}
+  #{yield if block}
+end}
+      end
+
+      def file_w_include name, module_name, &block
+        file name, "include #{module_name}", &block 
+      end
+
+      def simple_file name, module_name, &block
+        %Q{#{clazz name}
+  #{yield if block}
+end}
+      end
+
+      def file_w_inherit name, module_name, &block
+        %Q{#{clazz name} < #{module_name}
+  #{yield if block}
+end}
+      end 
+      
+      def field name, type = nil
+        return "#{field_name} :#{name}, #{type}" if type
+        "#{field_name} :#{name}"
+      end      
+    end
+  end
+end
+              
+require_all File.dirname(__FILE__) + '/orm'

data/lib/rails3_artifactor/base/class_methods.rb

@@ -0,0 +1,9 @@
+module Rails3::Assist
+  module BaseHelper
+    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
+  end
+end

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

@@ -0,0 +1,48 @@
+module Rails3::Assist::Artifact::CRUD
+  module Create             
+    include Rails3::Assist::Artifact::Marker
+    
+    def create_artifact name, options={}, &block
+      type = get_type(options)
+      file = make_file_name(name, type)
+      return nil if File.exist?(file)
+
+      create_artifact_dir(file)      
+      content = get_content(name, type, content, options, &block)
+      return if content.blank?
+
+      File.overwrite file, content      
+    end
+
+    protected
+    
+    def new_artifact_content name, type, content=nil, &block
+      content ||= yield if block
+      %Q{class #{marker(name, type)}
+  #{content}
+end}
+    end    
+
+    private
+
+    def content_method type 
+      method = :"new_#{type}_content"      
+      raise "Content method #{content_method} not found #{orm_notify}" if !respond_to?(method)
+      method
+    end
+
+
+    def create_artifact_dir file
+      # make dir        
+      dir = File.dirname(file)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+    end
+    
+    def get_content name, type, content, options = {}, &block
+      content = block ? yield : options[:content]
+      content = type == :model ? content : options.merge(:content => content)
+      method = content_method(type)
+      send method, name, content, &block
+    end    
+  end 
+end