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

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,60 @@
+# 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/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', __FILE__)
+
+      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

@@ -20,6 +20,16 @@ module AwsRecord
       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)
@@ -104,6 +114,28 @@ module AwsRecord
         @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

data/lib/generators/test_helper.rb

@@ -11,8 +11,9 @@
 # or implied. See the License for the specific language governing permissions
 # and limitations under the License.
 
-require 'rails/generators/rails/app/app_generator'
+require "rails/generators/rails/app/app_generator"
 require "rails/generators/testing/behaviour"
+require "rails/generators/testing/assertions"
 require "fileutils"
 require "minitest/spec"
 
@@ -23,6 +24,7 @@ module AwsRecord
       attr_accessor :assertions
 
       include Rails::Generators::Testing::Behaviour
+      include Rails::Generators::Testing::Assertions
       include FileUtils
 
       def initialize(klass, dest)
@@ -47,14 +49,21 @@ module AwsRecord
         ensure_current_path
       end
 
-      def assert_file(generated_file, actual_file)
+      def assert_file_fixture(generated_file, actual_file)
         assert File.exist?(generated_file), "Expected file #{generated_file.inspect} to exist, but does not"
         assert File.exist?(actual_file), "Expected file #{actual_file.inspect} to exist, but does not"
         assert identical? generated_file, actual_file
       end
 
-      def assert_not_file(file_path)
-        assert !File.exist?(file_path), "Expected file #{file_path.inspect} to not exist, but does"
+      def assert_model_rand_table_name(generated_file, actual_file, table_name)
+        assert File.exist?(generated_file), "Expected file #{generated_file.inspect} to exist, but does not"
+        assert File.exist?(actual_file), "Expected file #{actual_file.inspect} to exist, but does not"
+
+        fixture = File.read(actual_file)
+        generated = File.read(generated_file)
+        fixture = fixture.gsub(/#table_name#/, table_name)
+
+        assert fixture == generated
       end
 
       def cleanup
@@ -62,15 +71,17 @@ module AwsRecord
       end
 
       def run_generator(args = default_arguments, config = {})
+        result = nil
         capture(:stderr) do
-          super
+          result = super
         end
+        result
       end
 
       private
 
       def setup_test_app
-        Rails::Generators::AppGenerator.start [destination_root, '--skip-bundle', '--skip-git', '--skip-spring', '--skip-test', '-d' , '--skip-javascript', '--force', '--quiet']
+        Rails::Generators::AppGenerator.start [destination_root, '--skip-bundle', '--skip-git', '--skip-spring', '--skip-test', '--force', '--quiet']
         `echo 'gem "aws-record-generator", :path => "../../"' >> "#{destination_root}/Gemfile"`
         `bundle install --gemfile "#{destination_root}/Gemfile"`
       end

data/lib/tasks/table_config_migrate_task.rake

@@ -17,7 +17,7 @@ namespace :aws_record do
   task migrate: :environment do
     Dir[File.join('db', 'table_config', '**/*.rb')].each do |filename|
       puts "running #{filename}"
-      load(filename)
+      require (File.expand_path(filename))
 
       table_config = ModelTableConfig.config
       table_config.migrate! unless table_config.compatible?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record-generator
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.0.pre.2
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-record
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -46,10 +46,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/aws-record-generator.rb
+- lib/generators/aws_record/active_model.rb
+- lib/generators/aws_record/base.rb
+- lib/generators/aws_record/erb/erb_generator.rb
+- lib/generators/aws_record/erb/templates/_form.html.erb.tt
+- lib/generators/aws_record/erb/templates/edit.html.erb.tt
+- lib/generators/aws_record/erb/templates/index.html.erb.tt
+- lib/generators/aws_record/erb/templates/new.html.erb.tt
+- lib/generators/aws_record/erb/templates/show.html.erb.tt
 - lib/generators/aws_record/model/USAGE
 - lib/generators/aws_record/model/model_generator.rb
 - lib/generators/aws_record/model/templates/model.rb.tt
 - lib/generators/aws_record/model/templates/table_config.rb.tt
+- lib/generators/aws_record/resource/USAGE
+- lib/generators/aws_record/resource/resource_generator.rb
+- lib/generators/aws_record/scaffold/USAGE
+- lib/generators/aws_record/scaffold/scaffold_generator.rb
+- lib/generators/aws_record/scaffold_controller/USAGE
+- lib/generators/aws_record/scaffold_controller/scaffold_controller_generator.rb
+- lib/generators/aws_record/scaffold_controller/templates/api_controller.rb.tt
+- lib/generators/aws_record/scaffold_controller/templates/controller.rb.tt
 - lib/generators/generated_attribute.rb
 - lib/generators/secondary_index.rb
 - lib/generators/test_helper.rb