aws-record-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5559912f4320e4963f91af1adb907079abd0c1983ab1a517bc5ccac1456c8b92
+  data.tar.gz: 58507fa8d3d7ec5671765dbcb962f9d45cfc3181601214786b2d1d7f56a47a2f
+SHA512:
+  metadata.gz: ff8d42eebfd7b9e309f6809c6c50989ba92ef93cf8f33012b9135e151956eaa85f5783c865707530f365a60bca4560dc5de95ab8fdc9310138d61c68de60027e
+  data.tar.gz: 84d2e7097f486cca737fe4fb7584010fabe3103da33726c4120dedb29bb0469567ddbe32032f35bce379cefd40966a059d95929eb8b1d4fa93cbdccf32db9c55

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (2024-11-16)
+------------------
+
+* Feature - Initial version of this gem.

data/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/aws-record-rails.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'generators/generated_attribute'
+require_relative 'generators/secondary_index'
+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'
+
+module Aws
+  module Record
+    module Rails
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+
+      # @api private
+      class Railtie < ::Rails::Railtie
+        rake_tasks do
+          load 'tasks/aws_record/migrate.rake'
+        end
+      end
+    end
+  end
+end

data/lib/generators/aws_record/active_model.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+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? ? nil : rkey[0]
+
+        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,212 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+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!
+
+        return if @parse_errors.empty?
+
+        warn 'The following errors were encountered while trying to parse the given attributes'
+        $stderr.puts
+        warn @parse_errors
+        $stderr.puts
+
+        abort('Please fix the errors before proceeding.')
+      end
+
+      def parse_attributes!
+        self.attributes = (attributes || []).map do |attr|
+          GeneratedAttribute.parse(attr)
+        rescue ArgumentError => e
+          @parse_errors << e
+          next
+        end
+        self.attributes = attributes.compact
+
+        if options['password_digest']
+          attributes << GeneratedAttribute.new('password_digest', :string_attr, digest: true)
+        end
+
+        return unless options['timestamps']
+
+        attributes << GeneratedAttribute.parse('created:datetime:default_value{Time.now}')
+        attributes << GeneratedAttribute.parse('updated:datetime:default_value{Time.now}')
+      end
+
+      def ensure_unique_fields
+        used_names = Set.new
+        duplicate_fields = []
+
+        attributes.each do |attr|
+          duplicate_fields << [:attribute, attr.name] if used_names.include? attr.name
+          used_names.add attr.name
+
+          next unless 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
+
+          duplicate_fields << [:database_attribute_name, raw_db_attr_name] if used_names.include? raw_db_attr_name
+
+          used_names.add raw_db_attr_name
+        end
+
+        return 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
+
+      def ensure_hkey
+        uuid_member = nil
+        hkey_member = nil
+        rkey_member = nil
+
+        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
+
+          uuid_member = attr if attr.name.include? 'uuid'
+        end
+
+        return if hkey_member
+
+        if uuid_member
+          uuid_member.options[:hash_key] = true
+        else
+          attributes.unshift GeneratedAttribute.parse('uuid:hkey')
+        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.to_h do |idx|
+          [idx.name, parse_rw_units(idx.name)]
+        end
+
+        options['table_config'].each_key do |config|
+          next if config == 'primary'
+
+          gsi = @gsis.select { |idx| idx.name == config }
+
+          @parse_errors << ArgumentError.new("Could not find a gsi declaration for #{config}") if gsi.empty?
+        end
+      end
+
+      def parse_rw_units(name)
+        if options['table_config'].key? name
+          rw_units = options['table_config'][name]
+          rw_units.gsub(/[,.-]/, ':').split(':').reject(&:empty?)
+        else
+          @parse_errors << ArgumentError.new("Please provide a table_config definition for #{name}")
+        end
+      end
+
+      def parse_gsis!
+        @gsis = (options['gsi'] || []).map do |raw_idx|
+          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
+
+        @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 attributes.none? do |attr|
+            attr.name == val_attr
+          end
+        end
+
+        @length_validations = options['length_validations'].map do |val_attr, bounds|
+          @parse_errors << ArgumentError.new("No such field #{val_attr} in required validations") if attributes.none? do |attr|
+            attr.name == val_attr
+          end
+
+          bounds = bounds.gsub(/[,.-]/, ':').split(':').reject(&: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,55 @@
+# frozen_string_literal: true
+
+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', __dir__)
+
+      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 %>

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

@@ -0,0 +1,24 @@
+Description:
+    rails generator for aws-record models
+
+    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.
+
+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}
+
+    This will create:
+        app/models/forum.rb
+        db/table_config/forum_config.rb
+        lib/tasks/table_config_migrate_task.rake # This is created once the first time the generator is run