shaf 0.1.0.beta

data/lib/shaf/generator/migration/add_column.rb

@@ -0,0 +1,49 @@
+module Shaf
+  module Generator
+    module Migration
+      class AddColumn < Base
+
+        identifier %w(add column)
+        usage 'generate migration add column TABLE_NAME field:type'
+
+        def validate_args
+          if (table_name || "").empty?
+            raise "Please provide a table and at least " \
+              "one column when generation add column migration"
+          elsif args.size < 2 || (args[1] || "").empty?
+            raise "Please provide at least one column when " \
+              "generation add column migration"
+          end
+        end
+
+        def compile_migration_name
+          cols = columns.map { |c| c.split(':').first }
+          "add_#{cols.join('_')}_to_#{table_name}"
+        end
+
+        def table_name
+          args.first
+        end
+
+        def compile_changes
+          add_change add_columns_change
+        end
+
+        def columns
+          args[1..-1]
+        end
+
+        def add_columns_change
+          cols = columns.map do |s|
+            "add_column #{column_def(s, create: false)}"
+          end
+          [
+            "alter_table(:#{table_name}) do",
+            *cols.map { |col| col.prepend("  ") }, # indent body with 2 spaces
+            "end\n"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/shaf/generator/migration/create_table.rb

@@ -0,0 +1,40 @@
+module Shaf
+  module Generator
+    module Migration
+      class CreateTable < Base
+
+        identifier %w(create table)
+        usage 'generate migration create table TABLE_NAME [field:type] [..]'
+
+        def validate_args
+          return unless table_name.empty?
+          raise "Please provide a table name when generation a create table migration"
+        end
+
+        def compile_migration_name
+          "create_#{table_name}_table"
+        end
+
+        def table_name
+          args.first || ""
+        end
+
+        def compile_changes
+          add_change create_table_change
+        end
+
+        def create_table_change
+          cols = ["primary_key :id"]
+          cols += ["DateTime :created_at", "DateTime :updated_at"] if add_timestamp_columns?
+          cols += args[1..-1].map { |s| column_def(s) }
+          [
+            "create_table(:#{table_name}) do",
+            *cols.map { |col| col.prepend("  ") }, # indent body with 2 spaces
+            "end\n\n"
+          ]
+        end
+
+      end
+    end
+  end
+end

data/lib/shaf/generator/migration/drop_column.rb

@@ -0,0 +1,45 @@
+module Shaf
+  module Generator
+    module Migration
+      class DropColumn < Base
+
+        identifier %w(drop column)
+        usage 'generate migration drop column TABLE_NAME COLUMN_NAME'
+
+        def validate_args
+          if table_name.empty?
+            raise "Please provide a table and at least " \
+              "one column when generation add column migration"
+          elsif column.empty?
+            raise "Please provide at least one column when " \
+              "generation add column migration"
+          end
+        end
+
+        def compile_migration_name
+          "drop_#{column}_from_#{table_name}"
+        end
+
+        def compile_changes
+          add_change drop_column_change
+        end
+
+        def table_name
+          args.first || ""
+        end
+
+        def column
+          args[1] || ""
+        end
+
+        def drop_column_change
+          [
+            "alter_table(:#{table_name}) do",
+            "  drop_column :#{column}",
+            "end\n"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/shaf/generator/migration/empty.rb

@@ -0,0 +1,21 @@
+module Shaf
+  module Generator
+    module Migration
+      class Empty < Base
+
+        identifier %r(\A\Z)
+        usage 'generate migration'
+
+        def validate_args; end
+
+        def compile_migration_name
+          "empty"
+        end
+
+        def compile_changes
+          add_change nil
+        end
+      end
+    end
+  end
+end

data/lib/shaf/generator/migration/rename_column.rb

@@ -0,0 +1,48 @@
+module Shaf
+  module Generator
+    module Migration
+      class RenameColumn < Base
+
+        identifier %w(rename column)
+        usage 'generate migration rename column TABLE_NAME OLD_NAME NEW_NAME'
+
+        def validate_args
+          if table_name.empty?
+            raise "Please provide a table and at least " \
+              "one column when generation add column migration"
+          elsif from_col.empty? || to_col.empty?
+            raise "Please provide the old column name and the new column name"
+          end
+        end
+
+        def compile_migration_name
+          "rename_#{table_name}_#{from_col}_to_#{to_col}"
+        end
+
+        def compile_changes
+          add_change rename_column_change
+        end
+
+        def table_name
+          args.first || ""
+        end
+
+        def from_col
+          args[1] || ""
+        end
+
+        def to_col
+          args[2] || ""
+        end
+
+        def rename_column_change
+          [
+            "alter_table(:#{table_name}) do",
+            "  rename_column :#{from_col}, :#{to_col}",
+            "end\n"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/shaf/generator/model.rb

@@ -0,0 +1,68 @@
+module Shaf
+  module Generator
+    class Model < Base
+
+      identifier :model
+      usage 'generate model MODEL_NAME [attribute:type] [..]'
+
+      def call
+        if model_name.empty?
+          raise "Please provide a model name when using the model generator!"
+        end
+
+        create_model
+        create_migration
+        create_serializer
+      end
+
+      def model_name
+        args.first || ""
+      end
+
+      def table_name
+        Utils::pluralize model_name
+      end
+
+      def template
+        'api/model.rb'
+      end
+
+      def target
+        "api/models/#{model_name}.rb"
+      end
+
+      def create_model
+        content = render(template, opts)
+        write_output(target, content)
+      end
+
+      def form_fields
+        args[1..-1].map do |f|
+          (name, type, label) = f.split(':')
+          type ||= "string"
+          label_str = label ? %Q(, label: "#{label}") : ""
+          format 'field :%s, type: "%s"%s' % [name, type, label_str]
+        end
+      end
+
+      def opts
+        {
+          model_name: model_name,
+          class_name: model_name.capitalize,
+          form_fields: form_fields
+        }
+      end
+
+      def create_migration
+        migration_args = %W(create table #{table_name}) + args[1..-1]
+        Migration::Generator.new(*migration_args).call
+      end
+
+      def create_serializer
+        serializer_args = %W(serializer #{model_name})
+        serializer_args += args[1..-1].map { |arg| arg.split(':').first }
+        Generator::Factory.create(*serializer_args).call
+      end
+    end
+  end
+end

data/lib/shaf/generator/policy.rb

@@ -0,0 +1,43 @@
+module Shaf
+  module Generator
+    class Policy < Base
+      identifier :policy
+      usage 'generate policy MODEL_NAME [attribute] [..]'
+
+      def call
+        if policy_name.empty?
+          raise "Please provide a policy name when using the policy generator!"
+        end
+        create_policy
+      end
+
+      def policy_name
+        args.first || ""
+      end
+
+      def template
+        'api/policy.rb'
+      end
+
+      def target
+        "api/policies/#{policy_name}_policy.rb"
+      end
+
+      def create_policy
+        content = render(template, opts)
+        write_output(target, content)
+      end
+
+      def attributes
+        args[1..-1].map { |attr| "attribute :#{attr}" }
+      end
+
+      def opts
+        {
+          policy_class_name: "#{policy_name.capitalize}Policy",
+          attributes: attributes,
+        }
+      end
+    end
+  end
+end

data/lib/shaf/generator/scaffold.rb

@@ -0,0 +1,26 @@
+module Shaf
+  module Generator
+    class Scaffold < Base
+
+      identifier :scaffold
+      usage 'generate scaffold RESOURCE_NAME [attribute:type] [..]'
+
+      def call
+        if name.empty?
+          raise "Please provide a resource name when using the scaffold generator!"
+        end
+
+        Generator::Factory.create('model', *args).call
+        Generator::Factory.create('controller', *controller_args).call
+      end
+
+      def name
+        args.first || ""
+      end
+
+      def controller_args
+        [name] + args[1..-1]
+      end
+    end
+  end
+end

data/lib/shaf/generator/serializer.rb

@@ -0,0 +1,258 @@
+module Shaf
+  module Generator
+    class Serializer < Base
+      identifier :serializer
+      usage 'generate serializer MODEL_NAME [attribute] [..]'
+
+      def call
+        if name.empty?
+          raise "Please provide a model name when using the serializer generator!"
+        end
+
+        create_serializer
+        create_serializer_spec
+        create_policy
+      end
+
+      def name
+        args.first || ""
+      end
+
+      def plural_name
+        Utils.pluralize(name)
+      end
+
+      def model_class_name
+        "::#{name.capitalize}"
+      end
+
+      def policy_class_name
+        "::#{name.capitalize}Policy"
+      end
+
+      def template
+        'api/serializer.rb'
+      end
+
+      def spec_template
+        'spec/serializer_spec.rb'
+      end
+
+      def target
+        "api/serializers/#{name}_serializer.rb"
+      end
+
+      def spec_target
+        "spec/serializers/#{name}_serializer_spec.rb"
+      end
+
+      def create_serializer
+        content = render(template, opts)
+        write_output(target, content)
+      end
+
+      def create_serializer_spec
+        content = render(spec_template, opts)
+        write_output(spec_target, content)
+      end
+
+      def attributes
+        args[1..-1].map { |attr| ":#{attr}" }
+      end
+
+      def attributes_with_doc
+        attributes.map do |attr|
+          [
+            "# FIXME: Write documentation for attribute #{attr}",
+            "attribute #{attr}"
+          ]
+        end
+      end
+
+      def links
+        %w(doc:up self doc:create-form doc:edit-form doc:edit doc:delete)
+      end
+
+      def curies_with_doc
+        [
+          <<~EOS.split("\n")
+            # Auto generated doc:  
+            # Link to the documentation for a given relation of the #{name} resource.
+            # This link is templated, which means that {rel} must be replaced by the
+            # appropriate relation name.  
+            # Method: GET  
+            # Example:
+            # ```
+            # curl -H "Accept: application/json" \\
+            #      /doc/#{name}/rels/edit
+            #```
+            curie :doc do
+              doc_curie_uri('#{name}')
+            end
+          EOS
+        ]
+      end
+
+      def links_with_doc
+        [
+          collection_link,
+          self_link,
+          new_link,
+          edit_link,
+          update_link,
+          delete_link,
+        ]
+      end
+
+      def collection_link
+        link(
+          rel: "doc:up",
+          desc: "Link to the collection of all #{plural_name}. " \
+          "Send a POST request to this uri to create a new #{name}",
+          method: "GET or POST",
+          uri: "/#{plural_name}",
+          uri_helper: "#{plural_name}_uri"
+        )
+      end
+
+      def self_link
+        link(
+          rel: "self",
+          desc: "Link to this #{name}",
+          uri: "/#{plural_name}/5",
+          uri_helper: "#{name}_uri(resource)"
+        )
+      end
+
+      def new_link
+        link(
+          rel: "doc:create-form",
+          desc: "Link to a form to create a new #{name}",
+          uri: "/#{plural_name}/form",
+          uri_helper: "new_#{name}_uri"
+        )
+      end
+
+      def edit_link
+        link(
+          rel: "doc:edit-form",
+          desc: "Link to a form to edit this resource",
+          uri: "/#{plural_name}/5/edit",
+          uri_helper: "edit_#{name}_uri(resource)"
+        )
+      end
+
+      def update_link
+        link(
+          rel: "doc:edit",
+          desc: "Link to update this #{name}",
+          method: "PUT",
+          uri: "/#{plural_name}/5",
+          uri_helper: "#{name}_uri(resource)"
+        )
+      end
+
+      def delete_link
+        link(
+          rel: "doc:delete",
+          desc: "Link to delete this #{name}",
+          method: "DELETE",
+          uri: "/#{plural_name}/5",
+          uri_helper: "#{name}_uri(resource)"
+        )
+      end
+
+      def link(rel:, method: "GET", desc:, uri:, uri_helper:)
+        <<~EOS.split("\n")
+          # Auto generated doc:  
+          # #{desc}.  
+          # Method: #{method}  
+          #{example(method, uri)}
+          link :'#{rel}' do
+            #{uri_helper}
+          end
+        EOS
+      end
+
+      def example(method, uri)
+        method_args = ""
+        case method
+        when "POST"
+          method_args = "\n#      -d@payload \\"
+        when "PUT"
+          method_args = "\n#      -X PUT -d@payload \\"
+        when "DELETE"
+          method_args = "\n#      -X DELETE \\"
+        end
+
+        <<~EOS.chomp
+          # Example:
+          # ```
+          # curl -H "Accept: application/json" \\
+          #      -H "Authorization: abcdef" \\#{method_args}
+          #      #{uri}
+          #```
+        EOS
+      end
+
+      def embeds
+        [:'doc:edit-form']
+      end
+
+      def embeds_with_doc
+        [
+          <<~EOS.split("\n")
+            # Auto generated doc:  
+            # A form to edit this #{name}
+            embed :'doc:edit-form' do
+              resource.edit_form.tap do |form|
+                form.self_link = edit_#{name}_uri(resource)
+                form.href = #{name}_uri(resource)
+              end
+            end
+          EOS
+        ]
+      end
+
+      def collection_with_doc
+        <<~EOS.split("\n")
+          collection of: '#{plural_name}' do
+            link :self, #{plural_name}_uri
+            link :up, root_uri
+            curie(:doc) { doc_curie_uri('#{name}') }
+          
+            embed :'doc:create-form' do
+              #{model_class_name}.create_form.tap do |form|
+                form.self_link = new_#{name}_uri
+                form.href = #{plural_name}_uri
+              end
+            end
+          end
+        EOS
+      end
+
+      def opts
+        {
+          name: name,
+          class_name: "#{name.capitalize}Serializer",
+          model_class_name: model_class_name,
+          policy_class_name: policy_class_name,
+          policy_name: "#{name}_policy",
+          attributes: attributes,
+          links: links,
+          embeds: embeds,
+          attributes_with_doc: attributes_with_doc,
+          curies_with_doc: curies_with_doc,
+          links_with_doc: links_with_doc,
+          embeds_with_doc: embeds_with_doc,
+          collection_with_doc: collection_with_doc,
+        }
+      end
+
+      def create_policy
+        policy_args = ["policy", name, *args[1..-1]]
+        Generator::Factory.create(*policy_args).call
+      end
+    end
+  end
+end