aws-record-rails 0.1.0

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'generators/aws_record/base'
+
+module AwsRecord
+  module Generators
+    class ModelGenerator < Base
+      def initialize(args, *options)
+        self.class.source_root File.expand_path('templates', __dir__)
+        super
+      end
+
+      def create_model
+        template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      end
+
+      def create_table_config
+        return unless options['table_config']
+
+        template 'table_config.rb',
+                 File.join('db/table_config', class_path, "#{file_name}_config.rb")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'aws-record'
+<% if has_validations? -%>
+require 'active_model'
+<% end -%>
+
+<% module_namespacing do -%>
+class <%= class_name %>
+  include Aws::Record
+<% 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 %>
+<% end -%>
+<% gsis.each do |index| %>
+  global_secondary_index(
+    :<%= index.name %>,
+    hash_key: :<%= index.hash_key -%>,<%- if index.range_key %>
+    range_key: :<%= index.range_key -%>,<%- end %>
+    projection: {
+      projection_type: <%= index.projection_type %>
+    }
+  )
+<% end -%>
+<% if !required_attrs.empty? -%>
+  validates_presence_of <% *req, last_req = required_attrs -%><% req.each do |required_validation|-%>:<%= required_validation %>, <% end -%>:<%= last_req %>
+<% end -%>
+<% 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/model/templates/table_config.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'aws-record'
+
+module ModelTableConfig
+  def self.config
+    Aws::Record::TableConfig.define do |t|
+      t.model_class <%= class_name %>
+
+      t.read_capacity_units <%= primary_read_units %>
+      t.write_capacity_units <%= primary_write_units %>
+      <%- gsis.each do |index| %>
+      t.global_secondary_index(:<%= index.name %>) do |i|
+        i.read_capacity_units <%= gsi_rw_units[index.name][0] %>
+        i.write_capacity_units <%= gsi_rw_units[index.name][1] %>
+      end
+      <%- end -%>
+    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,21 @@
+# frozen_string_literal: true
+
+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,46 @@
+# frozen_string_literal: true
+
+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', __dir__)
+
+      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]
+        return if options[:stylesheets] && options[:scaffold_stylesheet]
+
+        @options = @options.merge(stylesheet_engine: false)
+      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|
+        invoke stylesheet_engine, [controller_name] if behavior == :invoke
+      end
+
+      private
+
+      def initialize(args, *options)
+        options[0] << '--scaffold'
+        super
+      end
+    end
+  end
+end

data/lib/generators/aws_record/scaffold/templates/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}

data/lib/generators/aws_record/scaffold_controller/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Stubs out a scaffolded controller, its seven RESTful actions and related
+    views. Pass the model name, either CamelCased or under_scored. The
+    controller name is retrieved as a pluralized version of the model name.
+
+    This generates a controller class in app/controllers and invokes helper,
+    template engine framework generators.
+
+Example:
+    `rails generate scaffold_controller CreditCard...`
+
+    Credit card controller with URLs like /credit_cards.
+        Controller: app/controllers/credit_cards_controller.rb
+        Views:      app/views/credit_cards/index.html.erb [...]
+        Helper:     app/helpers/credit_cards_helper.rb

data/lib/generators/aws_record/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rails/generators/resource_helpers'
+require 'generators/aws_record/active_model'
+
+module AwsRecord
+  module Generators
+    class ScaffoldControllerGenerator < Base
+      include Rails::Generators::ResourceHelpers
+      source_root File.expand_path('templates', __dir__)
+
+      check_class_collision suffix: 'Controller'
+
+      class_option :helper, type: :boolean
+      class_option :orm, banner: 'NAME', type: :string, required: true,
+                         desc: 'ORM to generate the controller for'
+      class_option :api, type: :boolean,
+                         desc: 'Generates API controller'
+
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
+
+      def initialize(args, *options)
+        options[0] << '--skip-table-config'
+        super
+      end
+
+      def create_controller_files
+        template_file = options.api? ? 'api_controller.rb' : 'controller.rb'
+        template template_file,
+                 File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      end
+
+      hook_for :template_engine, in: :aws_record do |template_engine|
+        invoke template_engine unless options.api?
+      end
+
+      hook_for :test_framework, as: :scaffold
+
+      # Invoke the helper using the controller name (pluralized)
+      hook_for :helper, as: :scaffold, in: :rails do |invoked|
+        invoke invoked, [controller_name]
+      end
+
+      private
+
+      def orm_class
+        @orm_class = AwsRecord::Generators::ActiveModel
+      end
+    end
+  end
+end

data/lib/generators/aws_record/scaffold_controller/templates/api_controller.rb.tt

@@ -0,0 +1,63 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
+
+  # GET <%= route_url %>
+  def index
+    # Warning: This performs a full table scan, which can be very expensive if a table has many entries.
+    # It is strongly recommended to implement alternative approaches such as paginated queries.
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+
+    render json: <%= "@#{plural_table_name}" %>
+  end
+
+  # GET <%= route_url %>/1
+  def show
+    render json: <%= "@#{singular_table_name}" %>
+  end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      render json: <%= "@#{singular_table_name}" %>, status: :created, location: <%= "@#{singular_table_name}" %>
+    else
+      render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      render json: <%= "@#{singular_table_name}" %>
+    else
+      render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, attributes) %>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params.fetch(:<%= singular_table_name %>, {})
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/generators/aws_record/scaffold_controller/templates/controller.rb.tt

@@ -0,0 +1,70 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+
+  # GET <%= route_url %>
+  def index
+    # Warning: This performs a full table scan, which can be very expensive if a table has many entries.
+    # It is strongly recommended to implement alternative approaches such as paginated queries.
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+  end
+
+  # GET <%= route_url %>/1
+  def show
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+  end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      redirect_to <%= redirect_resource_name %>, notice: <%= "'#{human_name} was successfully created.'" %>
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to <%= redirect_resource_name %>, notice: <%= "'#{human_name} was successfully updated.'" %>
+    else
+      render :edit
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, attributes) %>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params.fetch(:<%= singular_table_name %>, {})
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/generators/generated_attribute.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module AwsRecord
+  module Generators
+    # @api private
+    class GeneratedAttribute
+      OPTS = %w[hkey rkey persist_nil db_attr_name ddb_type default_value].freeze
+      INVALID_HKEY_TYPES = %i[map_attr list_attr numeric_set_attr string_set_attr].freeze
+      attr_reader :name, :type
+      attr_accessor :options
+
+      def field_type
+        case @type
+        when :integer_attr then :number_field
+        when :date_attr then :date_select
+        when :datetime_attr then :datetime_select
+        when :boolean_attr then :check_box
+        else :text_field
+        end
+      end
+
+      class << self
+        def parse(field_definition)
+          name, type, opts = field_definition.split(':')
+          type ||= 'string'
+          if OPTS.any? { |opt| type.include? opt }
+            opts = type
+            type = 'string'
+          end
+
+          opts = opts.split(',') if opts
+          type, opts = parse_type_and_options(name, type, opts)
+          validate_opt_combs(name, type, opts)
+
+          new(name, type, opts)
+        end
+
+        private
+
+        def validate_opt_combs(name, type, opts)
+          return unless opts
+
+          is_hkey = opts.key?(:hash_key)
+          is_rkey = opts.key?(:range_key)
+
+          if is_hkey && is_rkey
+            raise ArgumentError,
+                  "Field #{name} cannot be a range key and hash key simultaneously"
+          end
+          return unless is_hkey && INVALID_HKEY_TYPES.include?(type)
+
+          raise ArgumentError,
+                "Field #{name} cannot be a hash key and be of type #{type}"
+        end
+
+        def parse_type_and_options(name, type, opts)
+          opts ||= []
+          [parse_type(name, type), opts.to_h { |opt| parse_option(name, opt) }]
+        end
+
+        def parse_option(name, opt)
+          case opt
+
+          when 'hkey'
+            [:hash_key, true]
+          when 'rkey'
+            [:range_key, true]
+          when 'persist_nil'
+            [:persist_nil, true]
+          when /db_attr_name\{(\w+)\}/
+            [:database_attribute_name, "\"#{::Regexp.last_match(1)}\""]
+          when /ddb_type\{(S|N|B|BOOL|SS|NS|BS|M|L)\}/i
+            [:dynamodb_type, "\"#{::Regexp.last_match(1).upcase}\""]
+          when /default_value\{(.+)\}/
+            [:default_value, ::Regexp.last_match(1)]
+          else
+            raise ArgumentError, "You provided an invalid option for #{name}: #{opt}"
+          end
+        end
+
+        def parse_type(name, type)
+          case type.downcase
+
+          when 'bool', 'boolean'
+            :boolean_attr
+          when 'date'
+            :date_attr
+          when 'datetime'
+            :datetime_attr
+          when 'float'
+            :float_attr
+          when 'int', 'integer'
+            :integer_attr
+          when 'list'
+            :list_attr
+          when 'map'
+            :map_attr
+          when 'num_set', 'numeric_set', 'nset'
+            :numeric_set_attr
+          when 'string_set', 's_set', 'sset'
+            :string_set_attr
+          when 'string'
+            :string_attr
+          else
+            raise ArgumentError, "Invalid type for #{name}: #{type}"
+          end
+        end
+      end
+
+      def initialize(name, type = :string_attr, options = {})
+        @name = name
+        @type = type
+        @options = options
+        @digest = options.delete(:digest)
+      end
+
+      # Methods used by rails scaffolding
+      def password_digest?
+        @digest
+      end
+
+      def polymorphic?
+        false
+      end
+
+      def column_name
+        if @name == 'password_digest'
+          'password'
+        else
+          @name
+        end
+      end
+
+      def human_name
+        name.humanize
+      end
+    end
+  end
+end