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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88db52d888ba8ab309db4f229686bc1cb036397d
-  data.tar.gz: 7ee3a11e989280135d8854d3eadf6acf04a7ac7d
+  metadata.gz: de7f749b7b824c00e0a9e627168e9b14f1df6b64
+  data.tar.gz: 74e29cd67ba2d6d8e6f655c75f1f238f65bfe676
 SHA512:
-  metadata.gz: 47607097dc142faee512968f5845a2ef511c53fa11ece5f352804faac451f4895f2d1e54f168b0b538b5b1416cf9dbbd925f58d82563c308b98a56707e6580c7
-  data.tar.gz: cb09166ed00e62c040732380b38ffde75a37065cb8755c2589f473ec12092d6b38513612c67c16681f4d73dd31f60c0638fcf3bf0632326c267b3531865dd2ca
+  metadata.gz: 22083943c64efc543caf45c6083e887443012cfc3cb1154f03a666b6d439b29cbac04c78d69492b225588caf56819ab9e9d467fbb96d235a5edb1e5938332a63
+  data.tar.gz: f455f61cbcf465eb890a1cacd12be95028d869df31416a7d75a51bb267ab16901cd3eb641d05e3d5608f7c6651a57bd83f8e8251aee0d700669b6fa5ba533eb1

data/lib/aws-record-generator.rb

@@ -14,7 +14,13 @@
 require_relative 'generators/generated_attribute'
 require_relative 'generators/secondary_index'
 require_relative 'generators/test_helper'
+require_relative 'generators/aws_record/base'
+
 require_relative 'generators/aws_record/model/model_generator'
+require_relative 'generators/aws_record/resource/resource_generator'
+require_relative 'generators/aws_record/erb/erb_generator'
+require_relative 'generators/aws_record/scaffold/scaffold_generator'
+require_relative 'generators/aws_record/scaffold_controller/scaffold_controller_generator'
 
 require 'aws-record'
 require 'rails/railtie'

data/lib/generators/aws_record/active_model.rb

@@ -0,0 +1,80 @@
+# 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.
+
+module AwsRecord
+    module Generators
+      class ActiveModel
+        attr_reader :name
+  
+        def initialize(name)
+          @name = name
+        end
+  
+        # GET index
+        def self.all(klass)
+          "#{klass}.scan"
+        end
+  
+        # GET show
+        # GET edit
+        # PATCH/PUT update
+        # DELETE destroy
+        def self.find(klass, attrs)
+          hkey = attrs.select{|attr| attr.options[:hash_key]}[0]
+          rkey = attrs.select{|attr| attr.options[:range_key]}
+          rkey = !rkey.empty? ? rkey[0] : nil
+
+          if rkey
+            """lambda {
+              id = params[:id].split('&').map{ |param| CGI.unescape(param) }
+              #{klass}.find(#{hkey.name}: id[0], #{rkey.name}: id[1])
+            }.call()"""
+          else
+            "#{klass}.find(#{hkey.name}: CGI.unescape(params[:id]))"
+          end
+        end
+  
+        # GET new
+        # POST create
+        def self.build(klass, params = nil)
+          if params
+            "#{klass}.new(#{params})"
+          else
+            "#{klass}.new"
+          end
+        end
+  
+        # POST create
+        def save
+          "#{name}.save"
+        end
+  
+        # PATCH/PUT update
+        def update(params = nil)
+          "#{name}.update(#{params})"
+        end
+  
+        # POST create
+        # PATCH/PUT update
+        def errors
+          "#{name}.errors"
+        end
+  
+        # DELETE destroy
+        def destroy
+          "#{name}.delete!"
+        end
+      end
+    end
+  end
+  

data/lib/generators/aws_record/base.rb

@@ -0,0 +1,228 @@
+# 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.
+
+module AwsRecord
+    module Generators
+      class Base < Rails::Generators::NamedBase
+        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 :table_name, type: :string, banner: "model_table_name"
+        class_option :password_digest, type: :boolean, desc: "Whether to add a password_digest field to the model"
+
+        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"
+        class_option :scaffold, type: :boolean, desc: "Adds helper methods that scaffolding uses"
+  
+        attr_accessor :primary_read_units, :primary_write_units, :gsi_rw_units, :gsis, :required_attrs, :length_validations
+        
+        private
+  
+        def initialize(args, *options)
+          options[0] << "--skip-table-config" if options[1][:behavior] == :revoke
+          @parse_errors = []
+          
+          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['password_digest']
+            self.attributes << GeneratedAttribute.new("password_digest", :string_attr, :digest => true)
+          end
+
+          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!
+          return unless options['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
+        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
+        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/erb/erb_generator.rb

@@ -0,0 +1,67 @@
+# 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/erb"
+require "rails/generators/resource_helpers"
+
+module AwsRecord
+  module Generators
+    class ErbGenerator < Base
+      include Rails::Generators::ResourceHelpers
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def initialize(args, *options)
+        options[0] << "--skip-table-config"
+        super
+      end
+
+      def create_root_folder
+        empty_directory File.join("app/views", controller_file_path)
+      end
+
+      def copy_view_files
+        available_views.each do |view|
+          formats.each do |format|
+            filename = filename_with_extensions(view, format)
+            template filename, File.join("app/views", controller_file_path, filename)
+          end
+        end
+      end
+
+    private
+
+      def available_views
+        %w(index edit show new _form)
+      end
+
+      def formats
+        [format]
+      end
+
+      def format
+        :html
+      end
+
+      def handler
+        :erb
+      end
+
+      def filename_with_extensions(name, file_format = format)
+        [name, file_format, handler].compact.join(".")
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+<%%= form_with(model: <%= model_resource_name %>, local: true) do |form| %>
+  <%% if <%= singular_table_name %>.errors.any? %>
+    <div id="error_explanation">
+      <h2><%%= pluralize(<%= singular_table_name %>.errors.count, "error") %> prohibited this <%= singular_table_name %> from being saved:</h2>
+
+      <ul>
+      <%% <%= singular_table_name %>.errors.full_messages.each do |message| %>
+        <li><%%= message %></li>
+      <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+<% attributes.each do |attribute| -%>
+  <div class="field">
+<% if attribute.password_digest? -%>
+    <%%= form.label :password %>
+    <%%= form.password_field :password %>
+  </div>
+
+  <div class="field">
+    <%%= form.label :password_confirmation %>
+    <%%= form.password_field :password_confirmation %>
+<% else -%>
+    <%%= form.label :<%= attribute.column_name %> %>
+    <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %> %>
+<% end -%>
+  </div>
+
+<% end -%>
+  <div class="actions">
+    <%%= form.submit %>
+  </div>
+<%% end %>

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

@@ -0,0 +1,6 @@
+<h1>Editing <%= singular_table_name.titleize %></h1>
+
+<%%= render 'form', <%= singular_table_name %>: @<%= singular_table_name %> %>
+
+<%%= link_to 'Show', @<%= singular_table_name %> %> |
+<%%= link_to 'Back', <%= index_helper %>_path %>

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

@@ -0,0 +1,31 @@
+<p id="notice"><%%= notice %></p>
+
+<h1><%= plural_table_name.titleize %></h1>
+
+<table>
+  <thead>
+    <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+      <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+        <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+        <td><%%= link_to 'Show', <%= model_resource_name %> %></td>
+        <td><%%= link_to 'Edit', edit_<%= singular_route_name %>_path(<%= singular_table_name %>) %></td>
+        <td><%%= link_to 'Destroy', <%= model_resource_name %>, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%%= link_to 'New <%= singular_table_name.titleize %>', new_<%= singular_route_name %>_path %>