jrhicks-static-generators 0.1.6

data/rails_generators/static_app/templates/static_style.css

@@ -0,0 +1,90 @@
+body {
+	font-family: "lucida grande", verdana, lucida, sans-serif;
+	font-size: 8pt;
+}
+
+
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#errorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+
+.sortable {
+	border: 1px solid #D9D9D9;
+	#border-collapse:separate;
+	border-spacing:0;
+}
+
+.sortable th {
+  border: 1px solid #FFF;
+  border-right-color: #CCC;
+  border-bottom-color: #CCC;
+  padding: 0 6px;
+  float: none !important; /*For Opera*/
+  float: left; /*For IE*/
+  background: #EEE;
+  color: #666;
+  font: bold 10px/22px Verdana, Arial, Helvetica, sans-serif;
+  text-decoration: none;
+  height: auto !important;
+  height: 1%; /*For IE*/
+}
+
+.sortable tbody tr td {
+	font-family: "lucida grande", verdana, sans-serif;
+	font-size: 8pt;
+	padding: 3px 8px;
+	border-left: 1px solid #D9D9D9;
+}
+
+.sortable tbody tr.selected td {
+	background-color: #3d80df;
+	color: #ffffff;
+	font-weight: bold;
+	border-left: 1px solid #346DBE;
+	border-bottom: 1px solid #7DAAEA;
+}
+

data/rails_generators/static_gen_specs/static_gen_specs_generator.rb

@@ -0,0 +1,343 @@
+class StaticGenSpecsGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false, :force_plural => false
+  
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_underscore_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_underscore_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    if @name == @name.pluralize && !options[:force_plural]
+      logger.warning "Plural version of the model detected, using singularized version.  Override with --force-plural."
+      @name = @name.singularize
+    end
+
+    @controller_name = @name.pluralize
+
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_underscore_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name=base_name.singularize
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+
+  def manifest
+    record do |m|
+        # Check for class naming collisions.
+        m.class_collisions("#{controller_class_name}Controller", "#{controller_class_name}Helper")
+        m.class_collisions(class_name)
+
+        # Controller, helper, views, test and stylesheets directories.
+        m.directory("static_scaffold")
+
+        # Model
+        m.template(
+              "generator_specs.rb",
+              File.join('static_scaffold',"generator_specs.rb"))
+        m.template(
+            "model_gen_specs.rb",
+            File.join('static_scaffold',"#{@controller_singular_name.underscore.downcase}_gen_specs.rb"))
+
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} static_gen_specs ModelName [table_name]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-timestamps",
+             "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      opt.on("--skip-migration",
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on("--force-plural",
+             "Forces the generation of a plural ModelName") { |v| options[:force_plural] = v }
+    end
+
+    def scaffold_views
+      %w[ index show new edit ]
+    end
+
+    def model_name
+      class_name.demodulize
+    end
+    
+    def columns
+        ActiveRecord::Base.connection.columns(table_name)    
+    end
+
+    def table_name
+        if @args and @args.length>=1
+            return @args.first
+        else
+            return @controller_plural_name
+        end
+    end
+    
+    def belongs_to_columns
+        # return columns indending in '_id'
+        columns.select {|c| c.name.slice(-3,3)=="_id"}
+    end
+    
+    def has_many_columns
+        # search other tables for foreign keys, match based on naming convention
+        # for example: friend_user_id would be assumed to be a foreign key to a User
+        results = []
+        tables = ActiveRecord::Base.connection.tables
+        ref_id = "#{model_name.underscore.singularize.downcase}_id"
+        for t in tables
+            for c in ActiveRecord::Base.connection.columns(t)
+                if c.name.slice(0-ref_id.length,ref_id.length)==ref_id
+                    results << {:table=>t, :column=>c.name}
+                end
+            end
+        end
+        return results
+    end
+    
+    # a helper method
+    
+    def max_length(objects, method)
+        (objects.map {|item| item.send(method.to_s).inspect.length} << method.to_s.length).max
+    end
+    
+    def column(col_name)
+        columns.select {|c| c.name==col_name }.first
+    end
+    
+    def column_names
+        cnames = columns.map {|c| c.name}
+    end    
+        
+    def estimate_cols(cname)
+        c=column(cname)
+        case c.type
+        when :text then 30
+        when :integer then
+            if belongs_to_columns.map {|bt| bt.name}.select {|name| name==cname}.first
+                30
+            else
+                5
+            end
+        when :datetime then 18
+        when :float then 8
+        when :string then estimate_string(cname)
+        else 30
+        end
+    end
+    
+    def estimate_rows(cname)
+        c=column(cname)
+        case c.type
+        when :text then 3
+        else 1
+        end
+    end
+    
+    def estimate_string(cname)
+        # Look for commonly named fields and guess length otherwise make an educated guess based on db limits
+        c=column(cname)
+        common_lengths = { "phone"=>15,"fax"=>15, "zip"=>12, "first_name"=> 15, "last_name"=>15 }
+        key=common_lengths.keys.select {|key| cname[key]}.first
+        if key
+            common_lengths[key]
+        else
+            case c.limit
+            when 0..15
+                c.limit
+            when 15..30
+                20
+            else
+                30
+            end
+        end
+    end
+    
+    def guess_type(cname)
+        if belongs_to_columns.map {|bt| bt.name}.select {|name| name==cname}.first
+            return :foreign_key
+        end
+        if cname=="id"
+            return :primary_key
+        end
+        if is_file_column?(cname)
+            return :file
+        end
+        if is_photo_column?(cname)
+            return :photo
+        end
+        return column(cname).type
+    end
+    
+    def guess_alignment(cname)
+        c=column(cname)
+        case guess_type(cname)
+        when :integer
+            "right"
+        when :float
+            "right"
+        when :decimal
+            "right"
+        else
+            "left"
+        end
+    end
+    
+    def guess_decimals(cname)
+        c=column(cname)
+        case guess_type(cname)
+        when :integer
+                0
+        when :float
+            3
+        when :decimal
+            3
+        else
+            nil
+        end
+    end
+    
+    def find_column_names_matching(name_list)
+        results = []
+        for item in name_list
+            results = results+column_names.select {|cname| cname.match(item)}
+        end
+        return results
+    end
+    
+    def is_photo_column?(cname)
+        find_column_names_matching("photo thumbnail".split).include?(cname)       
+    end
+    
+    def is_file_column?(cname)
+        find_column_names_matching("file fname attachment document fpath".split).include?(cname)
+    end
+    
+    def guess_short_name
+        guess = find_column_names_matching("name")
+        if guess.length==0
+            ["id"]
+        else
+            guess
+        end
+    end
+    
+    def guess_ordered_columns
+        # return names and dates otherwise id
+        names = columns.map {|c| c.name}.select {|name| name.match("name")}
+        dates = columns.select {|c| c.type==:datetime}.map {|c| c.name }
+        combined = names+dates
+        if combined
+            return combined
+        else
+            return "#{table_name}.id"
+        end
+    end
+    
+    def guess_list_columns
+        text_fields = columns.select {|c|c.type==:text}.map{|c|c.name}
+        meta_fields = ["id","created_at", "updated_at", "version", "guid"]
+        return column_names - text_fields - meta_fields
+    end
+    
+    # the idea here is to guess at whate columns should be included in the list/table view
+    # the anticipation is that some columns will be hidden by default
+    
+    def guess_in_list(cname)
+        c=column(cname)
+        if c.type==:text
+            return false
+        end
+        hidden_fields = "password guid".split
+        for h in hidden_fields
+            if cname.match(h)
+                return false
+            end
+        end
+
+        return true
+    end
+    
+    # units helpers - the idea is to encourage folks to append their units to the end of their db column names
+    
+    def units_hash
+        {
+            "_hrs" => "hours",
+            "_hours"=>"hours",
+            "_min"=>"minutes",
+            "_minutes"=>"minutes",
+            "_ppm"=>"ppm",
+            "_ppb"=>"ppb",
+            "_mgm3"=>"mg/m3",
+            "_f"=>"&deg;f",
+            "_c"=>"&deg;c",
+            "_rh"=>"% rh",
+            "_utf"=>""
+        }
+    end
+    
+    def units(cname)
+        u=units_hash[units_key(cname)]
+        if u
+            u
+        else
+            nil
+        end
+    end
+    
+    def label(cname)
+        ukey = units_key(cname)
+        if ukey
+            cname.slice(0,cname.length-ukey.length).titleize
+        else
+            cname.titleize
+        end
+    end
+    
+    def units_key(cname)
+        units_hash.keys.select {|k| cname.slice((0-k.length),k.length)==k }.first
+    end
+    
+    
+    
+end
+
+class CodeJustifier   
+    # This class is designed to generate readable code, but is a hypocrate
+
+    attr_accessor :objects, :parameters
+
+    def initialize(objects)
+        self.objects = objects
+        self.parameters = []
+    end
+
+    def add_parameter(&p)
+        self.parameters << p
+    end
+
+    def render(object)
+        self.parameters.map {|p| p.call(object).ljust(max_length(p))}.join("")
+    end
+
+    def max_length(parameter)
+        self.objects.map {|o| parameter.call(o).to_s.length }.max
+    end
+end

data/rails_generators/static_gen_specs/templates/generator_specs.rb

@@ -0,0 +1,60 @@
+# Load all generator specs
+#spec_files = Dir.glob(File.join(RAILS_ROOT,"static_scaffold","*.rb"))
+#for f in spec_files
+#    require f
+#end
+
+class GenSpecFactory
+
+    def GenSpecFactory.constantize(mname)
+        if mname.type==Array
+            return mname.map {|m|m.constantize_gen_spec}
+        else
+            # Instantiate the GenSpec based on model name
+            mname = model_name if not mname
+            gen_specs_mname = "#{mname}GenSpecs"
+            Object::const_get(gen_specs_mname).new()
+        end
+    end
+end
+
+
+class GeneratorSpecs < GenSpecFactory
+    
+    
+    def table_name
+        raise Exception("table_name method not implimented.")
+    end
+    
+    def schema
+        ActiveRecord::Base.connection.columns(table_name)    
+    end
+    
+    def small_icon
+        "small_icon_#{table_name}.gif"
+    end
+    
+    def model_file_name
+         # <%=model_name.underscore.inspect%>
+         model_name.underscore
+    end
+
+    def controller_class_name
+        # <%="#{model_name.pluralize}Controller".inspect%>
+        "#{model_name.pluralize}Controller"
+    end
+    
+    def controller_file_name
+        # "<%="#{model_name.pluralize}Controller".underscore.inspect%>"
+        "#{model_name.pluralize}Controller".underscore
+    end
+    
+    def view_folder_name
+        # <%=model_name.underscore.inspect%> 
+        model_name.pluralize.underscore
+    end
+
+    
+end
+
+