rails_artifactor 0.3.3

data/lib/rails_artifactor/artifact/markers.rb

@@ -0,0 +1,73 @@
+module RailsAssist::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}Permit < Permit::Base"
+    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 RailsAssist::BaseHelper    
+    
+    def model_marker name, options={}
+      return send :orm_marker_name, 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/rails_artifactor/artifact/migration.rb

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

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

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

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

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

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

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

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

@@ -0,0 +1,23 @@
+module RailsAssist::Orm
+  module Mongoid
+    include RailsAssist::Orm::Base
+
+    def orm_name
+      'Mongoid'
+    end
+
+    def field_name
+      'field'
+    end
+
+    def new_model_content name, options={}, &block        
+      content = block ? yield : options[:content]
+      file_w_include(name, orm_marker_name(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/rails_artifactor/artifact/orm/none.rb

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

data/lib/rails_artifactor/artifact/orm.rb

@@ -0,0 +1,55 @@
+module RailsAssist
+  module Orm
+    module Base
+      def self.included base
+        base.class_eval do
+          include RailsAssist::Artifact::Model
+        end
+      end
+
+      protected
+
+      def orm_marker_name 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/rails_artifactor/artifact/view_artifact.rb

@@ -0,0 +1,94 @@
+module RailsAssist::Artifact
+  module View
+    include RailsAssist::BaseHelper
+    include RailsAssist::Artifact::CRUD
+
+    def has_view? name, *args, &block
+      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 *args
+      view_file_name(args)
+    end
+    
+    # CREATE
+    def create_view *args, &block
+      file_name = view_file_name(args)      
+      dir = File.dirname(file_name)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+
+      content = get_view_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 *args, &block
+      file_name = view_file_name(args)
+      debug "reading from: #{file_name}"
+      begin
+        file = File.new(file_name)
+        content = file.read
+        debug "read content: #{content}"
+        yield content if block
+        content
+      rescue
+        nil
+      end
+    end
+    
+    # UPDATE
+    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
+    def remove_view *args
+      file = view_file_name(args)
+      FileUtils.rm_f(file) if File.exist?(file)
+    end
+
+    # remove_views :edit, :show, :folder => :person
+    def remove_views *args
+      options = last_option args
+      raise ArgumentError, "Missing :folder option in the last argument which must be a Hash" if !options && !options[:folder]
+      args.to_symbols.each{|name| remove_view name, options}      
+    end
+
+    def get_view_content args
+      args = args.flatten
+      case args.first
+      when Hash
+        args.first[:content]
+      end
+    end    
+
+    multi_aliases_for :view 
+  end
+end

data/lib/rails_artifactor/artifact.rb

@@ -0,0 +1 @@
+require_all File.dirname(__FILE__) + '/artifact'

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

@@ -0,0 +1,62 @@
+require 'rails_artifactor/ruby_mutator'
+
+module RailsAssist::Artifact::CRUD
+  module Create             
+    include RailsAssist::Artifact::Marker
+    
+    def create_artifact name, options={}, &block
+      type = get_type(options)
+      file = make_file_name(name, type)
+      return nil if File.exist?(file) && options[:no_overwrite]
+
+      create_artifact_dir(file)      
+      content = get_content(name, type, options, &block)
+      
+      superclass = options[:superclass] if options[:superclass]
+
+      if superclass
+        content.extend(RailsAssist::RubyMutator)
+        content.remove_superclass
+        content.inherit_from "#{superclass}_permit"
+      end
+      
+      return if content.blank?
+
+      File.overwrite file, content      
+    end
+
+    protected
+    
+    def new_artifact_content name, options = {}, &block
+      type = get_type(options)
+      content = extract_content type, options, &block
+      %Q{class #{marker(name, type)}
+  #{content}
+end}
+    end
+
+    def create_artifact_dir file
+      # make dir        
+      dir = File.dirname(file)
+      FileUtils.mkdir_p dir if !File.directory?(dir)
+    end
+
+    def content_method type 
+      method = :"new_#{type}_content"      
+      raise "Content method #{content_method} not found #{orm_notify}" if !respond_to?(method)
+      method
+    end
+
+    def extract_content type, options, &block
+      content = block ? yield : options[:content]
+      content = type == :model ? options.merge(:content => content) : content
+    end    
+
+    def get_content name, type, options = {}, &block
+      content = extract_content type, options, &block
+      method = content_method(type)
+      options[:content] = content
+      send method, name, options, &block 
+    end        
+  end 
+end

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

@@ -0,0 +1,35 @@
+require 'sugar-high/array'
+
+require 'rails_artifactor/artifact/file_name/view'
+
+module RailsAssist::Artifact::CRUD
+  module Delete
+    class ViewHelper
+      extend RailsAssist::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
+        FileUtils.rm_f(file) 
+        debug "removed artifact: #{name}"  
+        true
+      rescue
+        debug "artifact to remove not found: #{name}"          
+        nil
+      end
+    end
+    alias_method :delete_artifact, :remove_artifact
+
+    def remove_artifacts *names
+      type = last_option(names)[:type]
+      names.flatten.select_labels.each{|name| remove_artifact(name, type) }
+    end
+    alias_method :delete_artifacts, :remove_artifacts    
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'sugar-high/file'
+
+module RailsAssist::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}"
+      File.read_from file_name, options, &block
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'sugar-high/arguments'
+
+module RailsAssist::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)
+                               
+      marker = marker_option(name, options) 
+      
+      blip = send :"#{type}_marker", name, options
+      options1 = options.merge marker 
+
+      before_last = options[:before_last]      
+      
+      res = File.insert_into file, options1, &block
+      if !res
+        # try with :embedded option if default doesn't work
+        mrk_opt = marker_option name, 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
+      type = options[:type]
+      file = existing_file_name(name, type)      
+      File.remove_content_from file, options, &block
+    end
+
+    def remove_from_artifacts *names, &block
+      options = last_option(names)
+      type = options[:type]
+      artifacts = names.flatten.select_labels
+      
+      artifacts.each do |name|
+        file = existing_file_name(name, type)
+        File.remove_content_from file, options, &block
+      end
+    end    
+    alias_hash :remove_from_artifact => :delete_from_artifact, :pluralize => true
+
+    def replace_in_artifact name, options={}, &block
+      type = options[:type]
+      file = existing_file_name(name, type)      
+      File.replace_content_from file, options, &block      
+    end
+    
+    def replace_in_artifacts *names, &block
+      options = last_option(names)
+      type = options[:type]
+      artifacts = names.flatten.select_labels
+      
+      artifacts.each do |name|
+        file = existing_file_name(name, type)
+        File.replace_content_from file, options, &block
+      end
+    end      
+    alias_hash :replace_in_artifact => :update_artifact, :pluralize => true    
+  end    
+end

data/lib/rails_artifactor/base/crud.rb

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

data/lib/rails_artifactor/base/file_name.rb

@@ -0,0 +1,41 @@
+require 'rails_assist/artifact'
+
+module RailsAssist::Artifact
+  module FileName         
+    include RailsAssist::Artifact::Directory
+    include RailsAssist::Artifact::Path
+
+    def make_file_name name, type, options={}      
+      send :"#{type}_file_name", name, options
+    end
+
+    def existing_file_name name, type=nil, options = {} 
+      # first try finder method
+      finder_method = :"find_#{type}"       
+      if respond_to?(finder_method)          
+        result = send finder_method, name, options 
+        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 StandardError, "The method #find_#{type} to find the migration is not available!"
+      end
+      
+      # default for non-migration
+      file_name = make_file_name name, type, options
+      raise IOError, "No file for :#{type} found at location: #{file_name}" if !File.file?(file_name)
+      file_name
+    end
+
+    RailsAssist.artifacts.each do |name|
+      class_eval %{
+        def existing_#{name}_file name, type=nil, options = {}
+          existing_file_name name, type, options
+        end
+      } 
+    end
+  end  # file_name
+  
+  include FileName
+end    

data/lib/rails_artifactor/base.rb

@@ -0,0 +1 @@
+require_all File.dirname(__FILE__) + '/base'

data/lib/rails_artifactor/macro.rb

@@ -0,0 +1,2 @@
+# RailsAssist::UseMacro
+

data/lib/rails_artifactor/namespaces.rb

@@ -0,0 +1,10 @@
+require 'rails_assist'
+
+module RailsAssist
+  module Artifact
+    modules :crud
+    modules RailsAssist.artifacts do
+      nested_modules :file_name
+    end
+  end
+end

data/lib/rails_artifactor/rspec/configure.rb

@@ -0,0 +1,7 @@
+require 'rspec/core'
+require 'rails_artifactor/macro'
+
+RSpec.configure do |config|
+  config.extend   RailsAssist::UseMacro
+  config.include  RailsAssist::UseMacro
+end

data/lib/rails_artifactor/rspec.rb

@@ -0,0 +1 @@
+require_all File.dirname(__FILE__) + '/rspec'

data/lib/rails_artifactor/ruby_mutator.rb

@@ -0,0 +1,11 @@
+module RailsAssist
+  module RubyMutator
+    def remove_superclass
+      self.gsub! /(class\s+\w+\s*)<\s*(\w|::)+/, '\1'
+    end
+  
+    def inherit_from superclass
+      self.gsub! /(class\s+(\w|::)+)/, '\1' + " < #{superclass.to_s.camelize}\n"
+    end
+  end
+end

data/lib/rails_artifactor/template_language/base.rb

@@ -0,0 +1,14 @@
+module RailsAssist
+  module TemplateLanguage
+    class Base
+      def insert_ruby_statement statement, options = {}, &block
+      end
+
+      def insert_ruby_block statement, options = {}, &block
+      end      
+
+      def insert_tag tag, css, options= {}, &block
+      end      
+    end
+  end
+end

data/lib/rails_artifactor/template_language/erb.rb

@@ -0,0 +1,24 @@
+module RailsAssist
+  module TemplateLanguage
+    class Erb < Base
+      def insert_ruby_statement statement, options = {}
+        "<%= #{statement} %>"
+      end
+      
+      def insert_ruby_block statement, options = {}, &block
+        %Q{"<%= #{statement} %>"
+#{yield}
+<% end %>
+}
+        # insert_content options
+      end      
+
+      def insert_tag tag, attributes, options= {}, &block
+        %Q{"<#{tag} #{attributes}>"
+#{yield}
+<#{tag}/>
+}
+      end            
+    end
+  end
+end

data/lib/rails_artifactor/template_language/haml.rb

@@ -0,0 +1,32 @@
+module RailsAssist
+  module TemplateLanguage
+    class Haml < Base
+      def insert_ruby_statement statement, options = {}
+        "\n= #{statement}"
+      end
+      
+      def insert_ruby_block statement, options = {}, &block
+        # get indentation of previous line
+        %Q{"<%= #{statement} %>"
+#{yield}
+<% end %>
+}
+      end      
+
+      def insert_tag tag, options= {}, &block
+        attributes = options[:attributes]
+        atr_atr = "{#{format attributes}}" if attributes
+        %Q{"%#{tag}#{atr_atr}"
+#{yield}
+<#{tag}/>
+}
+      end      
+      
+      protected
+      
+      def format attributes
+        attributes.map{|key, value| ":#{key} => \"#{value}\""}        
+      end
+    end
+  end
+end