aws-record-generator 1.0.0.pre.1 → 1.0.0.pre.2

data/lib/generators/aws_record/erb/templates/new.html.erb.tt

@@ -0,0 +1,5 @@
+<h1>New <%= singular_table_name.titleize %></h1>
+
+<%%= render 'form', <%= singular_table_name %>: @<%= singular_table_name %> %>
+
+<%%= link_to 'Back', <%= index_helper %>_path %>

data/lib/generators/aws_record/erb/templates/show.html.erb.tt

@@ -0,0 +1,11 @@
+<p id="notice"><%%= notice %></p>
+
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+<p>
+  <strong><%= attribute.human_name %>:</strong>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+<%%= link_to 'Edit', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>) %> |
+<%%= link_to 'Back', <%= index_helper %>_path %>

data/lib/generators/aws_record/model/USAGE

@@ -11,6 +11,9 @@ Description:
 
     Timestamps are not added by default but you can add them using the `--timestamps` flag
     More information can be found at: https://github.com/awslabs/aws-record-generator/blob/master/README.md
+    
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
 
 Example:
     rails generate aws_record:model Forum forum_uuid:hkey post_id:rkey post_title post_body tags:sset:default_value{Set.new} created_at:datetime:d_attr_name{PostCreatedAtTime} moderation:boolean:default_value{false}

data/lib/generators/aws_record/model/model_generator.rb

@@ -13,218 +13,25 @@
 
 require 'rails/generators'
 require 'aws-record-generator'
+require 'generators/aws_record/base'
 
 module AwsRecord
   module Generators
-    class ModelGenerator < Rails::Generators::NamedBase
-
-      source_root File.expand_path('../templates', __FILE__)
-      argument :attributes, type: :array, default: [], banner: "field[:type][:opts]...", desc: "Describes the fields in the model"
-      check_class_collision
-
-      class_option :disable_mutation_tracking, type: :boolean, desc: "Disables dirty tracking"
-      class_option :timestamps, type: :boolean, desc: "Adds created, updated timestamps to the model"
-      class_option :table_config, type: :hash, default: {}, banner: "primary:R-W [SecondaryIndex1:R-W]...", desc: "Declares the r/w units for the model as well as any secondary indexes", :required => true
-      class_option :gsi, type: :array, default: [], banner: "name:hkey{field_name}[,rkey{field_name},proj_type{ALL|KEYS_ONLY|INCLUDE}]...", desc: "Allows for the declaration of secondary indexes"
-      
-      class_option :required, type: :array, default: [], banner: "field1...", desc: "A list of attributes that are required for an instance of the model"
-      class_option :length_validations, type: :hash, default: {}, banner: "field1:MIN-MAX...", desc: "Validations on the length of attributes in a model"
-
-      attr_accessor :primary_read_units, :primary_write_units, :gsi_rw_units, :gsis, :required_attrs, :length_validations
-
-      def create_model
-        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
-      end
-
-      def create_table_config
-        template "table_config.rb", File.join("db/table_config", class_path, "#{file_name}_config.rb")
-      end
-
-      private
+    class ModelGenerator < Base
 
       def initialize(args, *options)
-        @parse_errors = []
-        
+        self.class.source_root File.expand_path('../templates', __FILE__)
         super
-        ensure_unique_fields
-        ensure_hkey
-        parse_gsis!
-        parse_table_config!
-        parse_validations!
-
-        if !@parse_errors.empty?
-          STDERR.puts "The following errors were encountered while trying to parse the given attributes"
-          STDERR.puts
-          STDERR.puts @parse_errors
-          STDERR.puts
-
-          abort("Please fix the errors before proceeding.")
-        end
-      end
-
-      def parse_attributes!
-
-        self.attributes = (attributes || []).map do |attr|
-          begin
-            GeneratedAttribute.parse(attr)
-          rescue ArgumentError => e
-            @parse_errors << e
-            next
-          end
-        end
-        self.attributes = self.attributes.compact
-
-        if options['timestamps']
-          self.attributes << GeneratedAttribute.parse("created:datetime:default_value{Time.now}")
-          self.attributes << GeneratedAttribute.parse("updated:datetime:default_value{Time.now}")
-        end
-      end
-
-      def ensure_unique_fields
-        used_names = Set.new
-        duplicate_fields = []
-
-        self.attributes.each do |attr|
-
-          if used_names.include? attr.name 
-            duplicate_fields << [:attribute, attr.name]
-          end
-          used_names.add attr.name
-
-          if attr.options.key? :database_attribute_name
-            raw_db_attr_name = attr.options[:database_attribute_name].delete('"') # db attribute names are wrapped with " to make template generation easier
-
-            if used_names.include? raw_db_attr_name
-              duplicate_fields << [:database_attribute_name, raw_db_attr_name]
-            end
-
-            used_names.add raw_db_attr_name
-          end
-        end
-
-        if !duplicate_fields.empty?
-          duplicate_fields.each do |invalid_attr|
-            @parse_errors << ArgumentError.new("Found duplicated field name: #{invalid_attr[1]}, in attribute#{invalid_attr[0]}")
-          end
-        end
       end
 
-      def ensure_hkey
-        uuid_member = nil
-        hkey_member = nil
-        rkey_member = nil
-
-        self.attributes.each do |attr|
-          if attr.options.key? :hash_key
-            if hkey_member
-              @parse_errors << ArgumentError.new("Redefinition of hash_key attr: #{attr.name}, original declaration of hash_key on: #{hkey_member.name}")
-              next
-            end
-
-            hkey_member = attr
-          elsif attr.options.key? :range_key
-            if rkey_member
-              @parse_errors << ArgumentError.new("Redefinition of range_key attr: #{attr.name}, original declaration of range_key on: #{hkey_member.name}")
-              next
-            end
-
-            rkey_member = attr
-          end
-
-          if attr.name.include? "uuid"
-            uuid_member = attr
-          end
-        end
-
-        if !hkey_member
-          if uuid_member
-            uuid_member.options[:hash_key] = true
-          else
-            self.attributes.unshift GeneratedAttribute.parse("uuid:hkey")
-          end
-        end
-      end
-
-      def mutation_tracking_disabled?
-        options['disable_mutation_tracking']
-      end
-
-      def has_validations?
-        !@required_attrs.empty? || !@length_validations.empty?
-      end
-
-      def parse_table_config!
-        @primary_read_units, @primary_write_units = parse_rw_units("primary")
-
-        @gsi_rw_units = @gsis.map { |idx|
-          [idx.name, parse_rw_units(idx.name)]
-        }.to_h
-
-        options['table_config'].each do |config, rw_units|
-          if config == "primary"
-            next
-          else
-            gsi = @gsis.select { |idx| idx.name == config}
-
-            if gsi.empty?
-              @parse_errors << ArgumentError.new("Could not find a gsi declaration for #{config}")
-            end
-          end
-        end
-      end
-
-      def parse_rw_units(name)
-        if !options['table_config'].key? name
-          @parse_errors << ArgumentError.new("Please provide a table_config definition for #{name}")
-        else
-          rw_units = options['table_config'][name]
-          return rw_units.gsub(/[,.-]/, ':').split(':').reject { |s| s.empty? }
-        end
+      def create_model
+        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
       end
 
-      def parse_gsis!
-        @gsis = (options['gsi'] || []).map do |raw_idx|
-          begin
-            idx = SecondaryIndex.parse(raw_idx)
-
-            attributes = self.attributes.select { |attr| attr.name == idx.hash_key}
-            if attributes.empty?
-              @parse_errors << ArgumentError.new("Could not find attribute #{idx.hash_key} for gsi #{idx.name} hkey")
-              next
-            end
-
-            if idx.range_key
-              attributes = self.attributes.select { |attr| attr.name == idx.range_key}
-              if attributes.empty?
-                @parse_errors << ArgumentError.new("Could not find attribute #{idx.range_key} for gsi #{idx.name} rkey")
-                next
-              end
-            end
-
-            idx
-          rescue ArgumentError => e
-            @parse_errors << e
-            next
-          end
-        end
-        
-        @gsis = @gsis.compact
+      def create_table_config
+        template "table_config.rb", File.join("db/table_config", class_path, "#{file_name}_config.rb") if options["table_config"]
       end
 
-      def parse_validations!
-        @required_attrs = options['required']
-        @required_attrs.each do |val_attr|
-          @parse_errors << ArgumentError.new("No such field #{val_attr} in required validations") if !self.attributes.any? { |attr| attr.name == val_attr }
-        end
-
-        @length_validations = options['length_validations'].map do |val_attr, bounds|
-          @parse_errors << ArgumentError.new("No such field #{val_attr} in required validations") if !self.attributes.any? { |attr| attr.name == val_attr }
-          
-          bounds = bounds.gsub(/[,.-]/, ':').split(':').reject { |s| s.empty? }
-          [val_attr, "#{bounds[0]}..#{bounds[1]}"]
-        end
-        @length_validations = @length_validations.to_h
-      end
     end
   end
 end

data/lib/generators/aws_record/model/templates/model.rb.tt

@@ -1,14 +1,23 @@
 require 'aws-record'
-<%= "require 'active_model'
-" if has_validations? -%>
+<% if has_validations? -%>
+require 'active_model'
+<% end -%>
 
 <% module_namespacing do -%>
 class <%= class_name %>
   include Aws::Record
-<%= '  include ActiveModel::Validations
-' if has_validations? -%>
-<%= '  disable_mutation_tracking
-' if mutation_tracking_disabled? -%>
+<% if options.key? :scaffold -%>
+  extend ActiveModel::Naming
+<% end -%>
+<% if has_validations? -%>
+  include ActiveModel::Validations
+<% end -%>
+<% if options.key? :password_digest -%>
+  include ActiveModel::SecurePassword
+<% end -%>
+<% if mutation_tracking_disabled? -%>
+  disable_mutation_tracking
+<% end -%>
 
 <% attributes.each do |attribute| -%>
   <%= attribute.type %> :<%= attribute.name %><% *opts, last_opt = attribute.options.to_a %><%= ', ' if last_opt %><% opts.each do |opt| %><%= opt[0] %>: <%= opt[1] %>, <% end %><% if last_opt %><%= last_opt[0] %>: <%= last_opt[1] %><% end %>
@@ -29,5 +38,37 @@ class <%= class_name %>
 <% length_validations.each do |attribute, validation| -%>
   validates_length_of :<%= attribute %>, within: <%= validation %>
 <% end -%>
+<% if options.key? :scaffold -%>
+  
+  # Scaffolding helpers
+  def initialize(args = {})
+    super
+    @errors = ActiveModel::Errors.new(self)
+  end
+
+  attr_reader :errors
+
+  def to_model
+    self
+  end
+
+  def to_param
+    return nil unless persisted?
+
+    hkey = public_send(self.class.hash_key)
+    if self.class.range_key
+        rkey = public_send(self.class.range_key)
+        "#{CGI.escape(hkey)}&#{CGI.escape(rkey)}"
+    else
+        "#{CGI.escape(hkey)}"
+    end
+  end
+<% end -%>
+<% if options['table_name'] -%>
+  set_table_name "<%= options['table_name'] %>"
+<% end -%>
+<% if options.key? :password_digest -%>
+  has_secure_password
+<% end -%>
 end
 <% end -%>

data/lib/generators/aws_record/resource/USAGE

@@ -0,0 +1,23 @@
+Description:
+    Stubs out a new resource including an empty model and controller suitable
+    for a RESTful, resource-oriented application. Pass the singular model name,
+    either CamelCased or under_scored, as the first argument, and an optional
+    list of attribute pairs.
+
+    Attribute pairs are field:type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the model immediately.
+
+    This generator invokes your configured ORM and test framework, besides
+    creating helpers and add routes to config/routes.rb.
+
+    Unlike the scaffold generator, the resource generator does not create
+    views or add any methods to the generated controller.
+
+Examples:
+    `rails generate resource post` # no attributes
+    `rails generate resource post title:string body:text published:boolean`
+    `rails generate resource purchase order_id:integer amount:decimal`

data/lib/generators/aws_record/resource/resource_generator.rb

@@ -0,0 +1,31 @@
+# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not
+# use this file except in compliance with the License. A copy of the License is
+# located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+# or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+require "rails/generators/rails/resource_route/resource_route_generator"
+require "rails/generators/resource_helpers"
+require 'generators/aws_record/active_model'
+
+module AwsRecord
+  module Generators
+    class ResourceGenerator < ModelGenerator
+      include Rails::Generators::ResourceHelpers
+
+      hook_for :resource_route, in: :rails, required: true
+
+      private
+      def orm_class
+        @orm_class = AwsRecord::Generators::ActiveModel
+      end
+    end
+  end
+end

data/lib/generators/aws_record/scaffold/USAGE

@@ -0,0 +1,31 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views, along with a full test suite. The resource is ready to use as a
+    starting point for your RESTful, resource-oriented application.
+
+    Pass the name of the model (preferably in singular form), and an optional list of attributes
+
+    Attributes are declarations of the fields that you wish to store within a model. You can pass
+    a type and list of options for each attribtue in the form: `name:type:options` if you do not provide
+    a type, it is assumed that the attribute is of type `string_attr`
+
+    Each model should have an hkey, if one is not present a `uuid:hkey` will be created for you.
+
+    Timestamps are not added by default but you can add them using the `--timestamps` flag
+    More information can be found at: https://github.com/awslabs/aws-record-generator/blob/master/README.md 
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+    For example, 'scaffold post title:hkey body published:boolean' gives
+    you a model with those three attributes, a controller that handles
+    the create/show/update/destroy, forms to create and edit your posts, and
+    an index that lists them all, as well as a resources :posts declaration
+    in config/routes.rb.
+
+    If you want to remove all the generated files, run
+    'rails destroy scaffold ModelName'.
+
+Examples:
+    `rails generate scaffold post title:hkey body published:boolean`
+    `rails generate scaffold purchase amount:float:hkey tracking_id:integer:rkey`

data/lib/generators/aws_record/scaffold/scaffold_generator.rb

@@ -0,0 +1,56 @@
+# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not
+# use this file except in compliance with the License. A copy of the License is
+# located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+# or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+require "rails/generators/rails/scaffold/scaffold_generator"
+require "generators/aws_record/resource/resource_generator"
+
+module AwsRecord
+  module Generators
+    class ScaffoldGenerator < ResourceGenerator
+      source_root File.expand_path('../../model/templates', __FILE__)
+
+      remove_class_option :orm
+      remove_class_option :actions
+
+      class_option :api, type: :boolean
+      class_option :stylesheets, type: :boolean, desc: "Generate Stylesheets"
+      class_option :stylesheet_engine, desc: "Engine for Stylesheets"
+      class_option :assets, type: :boolean
+      class_option :resource_route, type: :boolean
+      class_option :scaffold_stylesheet, type: :boolean
+
+      def handle_skip
+        @options = @options.merge(stylesheets: false) unless options[:assets]
+        @options = @options.merge(stylesheet_engine: false) unless options[:stylesheets] && options[:scaffold_stylesheet]
+      end
+
+      hook_for :scaffold_controller, in: :aws_record, required: true
+
+      hook_for :assets, in: :rails do |assets|
+        invoke assets, [controller_name]
+      end
+
+      hook_for :stylesheet_engine, in: :rails do |stylesheet_engine|
+        if behavior == :invoke
+          invoke stylesheet_engine, [controller_name]
+        end
+      end
+
+      private
+      def initialize(args, *options)
+        options[0] << "--scaffold"
+        super
+      end
+    end
+  end
+end