shaf 1.6.0 → 3.0.0

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

@@ -3,22 +3,51 @@ require 'shaf/generator/migration/type'
 module Shaf
   module Generator
     module Migration
-      Type.add :integer,        create_template: 'Integer :%s',                 alter_template: 'add_column :%s, Integer'
-      Type.add :varchar,        create_template: 'String %s',                   alter_template: 'add_column :%s, String'
-      Type.add :string,         create_template: 'String :%s',                  alter_template: 'add_column :%s, String'
-      Type.add :text,           create_template: 'String :%s, text: true',      alter_template: 'add_column :%s, String, text: true'
-      Type.add :blob,           create_template: 'File :%s',                    alter_template: 'add_column :%s, File'
-      Type.add :bigint,         create_template: 'Bignum :%s',                  alter_template: 'add_column :%s, Bignum'
-      Type.add :double,         create_template: 'Float :%s',                   alter_template: 'add_column :%s, Float'
-      Type.add :numeric,        create_template: 'BigDecimal :%s',              alter_template: 'add_column :%s, BigDecimal'
-      Type.add :date,           create_template: 'Date :%s',                    alter_template: 'add_column :%s, Date'
-      Type.add :timestamp,      create_template: 'DateTime :%s',                alter_template: 'add_column :%s, DateTime'
-      Type.add :time,           create_template: 'Time :%s',                    alter_template: 'add_column :%s, Time'
-      Type.add :bool,           create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
-      Type.add :boolean,        create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
-      Type.add :index,          create_template: 'index :%s, unique: true',     alter_template: 'add_index :%s'
-
-      Type.add :foreign_key,
+      module Types
+        class << self
+          def add(name, **kwargs)
+            Type.new(name, **kwargs).tap do |type|
+              types[type.name] = type
+            end
+          end
+
+          def find(str)
+            name, _ = str.to_s.split(',', 2)
+            types[name.to_sym]
+          end
+
+          def all
+            types.values
+          end
+
+          private
+
+          def types
+            @types ||= {}
+          end
+
+          def clear
+            @types.clear if defined? @types
+          end
+        end
+      end
+
+      Types.add :integer,        create_template: 'Integer :%s',                 alter_template: 'add_column :%s, Integer'
+      Types.add :varchar,        create_template: 'String %s',                   alter_template: 'add_column :%s, String'
+      Types.add :string,         create_template: 'String :%s',                  alter_template: 'add_column :%s, String'
+      Types.add :text,           create_template: 'String :%s, text: true',      alter_template: 'add_column :%s, String, text: true'
+      Types.add :blob,           create_template: 'File :%s',                    alter_template: 'add_column :%s, File'
+      Types.add :bigint,         create_template: 'Bignum :%s',                  alter_template: 'add_column :%s, Bignum'
+      Types.add :double,         create_template: 'Float :%s',                   alter_template: 'add_column :%s, Float'
+      Types.add :numeric,        create_template: 'BigDecimal :%s',              alter_template: 'add_column :%s, BigDecimal'
+      Types.add :date,           create_template: 'Date :%s',                    alter_template: 'add_column :%s, Date'
+      Types.add :timestamp,      create_template: 'DateTime :%s',                alter_template: 'add_column :%s, DateTime'
+      Types.add :time,           create_template: 'Time :%s',                    alter_template: 'add_column :%s, Time'
+      Types.add :bool,           create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
+      Types.add :boolean,        create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
+      Types.add :index,          create_template: 'index :%s, unique: true',     alter_template: 'add_index :%s'
+
+      Types.add :foreign_key,
         create_template: 'foreign_key :%s, :%s',
         alter_template: 'add_foreign_key :%s, :%s',
         validator: ->(type, *args) {

data/lib/shaf/generator/model.rb

@@ -5,44 +5,59 @@ module Shaf
       identifier :model
       usage 'generate model MODEL_NAME [attribute:type] [..]'
 
+      def self.options(parser, options)
+        parser.on("--skip-model", "don't generate model or migration") do |s|
+          options[:skip_model] = s
+        end
+
+        parser.on("--skip-migration", "don't generate a migration") do |s|
+          options[:skip_migration] = s
+        end
+      end
+
       def call
-        create_model
-        create_migration
+        create_model unless skip_model?
+        create_migration unless skip_migration?
         create_serializer
         create_forms
       end
 
-      def model_name
-        n = args.first || ''
-        return n unless n.empty?
-        raise Command::ArgumentError,
-          'Please provide a model name when using the model generator!'
+      private
+
+      def skip_model?
+        options[:skip_model]
       end
 
-      def model_class_name
-        Utils.model_name(model_name)
+      def skip_migration?
+        options[:skip_migration] || skip_model?
       end
 
       def table_name
-        Utils.pluralize model_name
+        Utils.pluralize name_arg
       end
 
       def template
         'api/model.rb'
       end
 
-      def target
-        "api/models/#{model_name}.rb"
+      def target_dir
+        'api/models'
+      end
+
+      def target_name
+        "#{name}.rb"
       end
 
       def create_model
         content = render(template, opts)
+        content = wrap_in_module(content, module_name)
         write_output(target, content)
       end
 
       def opts
         {
           class_name: model_class_name,
+          table_name: [namespace, plural_name].compact.join('_')
         }
       end
 
@@ -52,13 +67,12 @@ module Shaf
       end
 
       def create_serializer
-        serializer_args = %W(serializer #{model_name})
-        serializer_args += args[1..-1].map { |arg| arg.split(':').first }
+        serializer_args = %W(serializer #{name_arg}) + args[1..-1]
         Generator::Factory.create(*serializer_args, **options).call
       end
 
       def create_forms
-        form_args = %W(forms #{model_name}) + args[1..-1]
+        form_args = %W(forms #{name_arg}) + args[1..-1]
         Generator::Factory.create(*form_args, **options).call
       end
     end

data/lib/shaf/generator/policy.rb

@@ -8,27 +8,21 @@ module Shaf
         create_policy
       end
 
-      def policy_name
-        n = args.first || ""
-        return n unless n.empty?
-        raise Command::ArgumentError,
-          "Please provide a policy name when using the policy generator!"
-      end
-
-      def model_class_name
-        Utils::model_name(policy_name)
-      end
-
       def template
         'api/policy.rb'
       end
 
-      def target
-        "api/policies/#{policy_name}_policy.rb"
+      def target_dir
+        'api/policies'
+      end
+
+      def target_name
+        "#{name}_policy.rb"
       end
 
       def create_policy
         content = render(template, opts)
+        content = wrap_in_module(content, module_name)
         write_output(target, content)
       end
 
@@ -39,7 +33,7 @@ module Shaf
       def opts
         {
           policy_class_name: "#{model_class_name}Policy",
-          name: policy_name,
+          name: name,
           attributes: attributes,
         }
       end

data/lib/shaf/generator/profile.rb

@@ -0,0 +1,47 @@
+module Shaf
+  module Generator
+    class Profile < Base
+      identifier :profile
+      usage 'generate profile NAME [attribute:type] [..]'
+
+      def call
+        create_profile
+      end
+
+      def template
+        'api/profile.rb'
+      end
+
+      def target_dir
+        'api/profiles'
+      end
+
+      def target_name
+        "#{name}.rb"
+      end
+
+      def attributes
+        args[1..-1].map do |attr|
+          name, type = attr.split(':')
+          type ||= 'String'
+          [name, type.capitalize]
+        end
+      end
+
+      def create_profile
+        content = render(template, opts)
+        content = wrap_in_module(content, module_name, search: 'class \w')
+        write_output(target, content)
+      end
+
+      def opts
+        {
+          profile_name: name,
+          profile_class_name: "#{model_class_name}",
+          attributes: attributes,
+          resource_name: resource_name,
+        }
+      end
+    end
+  end
+end

data/lib/shaf/generator/scaffold.rb

@@ -6,21 +6,18 @@ module Shaf
       usage 'generate scaffold RESOURCE_NAME [attribute:type] [..]'
 
       def call
-        if name.empty?
-          raise "Please provide a resource name when using the scaffold generator!"
-        end
+        check_name_arg!
 
         options[:specs] = true if options[:specs].nil? 
         Generator::Factory.create('model', *args, **options).call
-        Generator::Factory.create('controller', *controller_args, **options).call
+        Generator::Factory.create('controller', *args, **options).call
       end
 
-      def name
-        args.first || ""
-      end
+      def check_name_arg!
+        return if args.first && !args.first.empty?
 
-      def controller_args
-        [name] + args[1..-1]
+        raise Command::ArgumentError,
+          "Please provide a name when using the scaffold generator!"
       end
     end
   end

data/lib/shaf/generator/serializer.rb

@@ -2,27 +2,17 @@ module Shaf
   module Generator
     class Serializer < Base
       identifier :serializer
-      usage 'generate serializer MODEL_NAME [attribute] [..]'
+      usage 'generate serializer MODEL_NAME [attribute[:type]] [..]'
 
       def call
         create_serializer
         create_serializer_spec if options[:specs]
         create_policy
+        create_profile
       end
 
-      def name
-        n = args.first || ""
-        return n unless n.empty?
-        raise Command::ArgumentError,
-          "Please provide a model name when using the serializer generator!"
-      end
-
-      def plural_name
-        Utils.pluralize(name)
-      end
-
-      def model_class_name
-        Utils.model_name(name)
+      def serializer_class_name
+        "#{model_class_name}Serializer"
       end
 
       def policy_class_name
@@ -37,59 +27,62 @@ module Shaf
         'spec/serializer_spec.rb'
       end
 
-      def target
-        "api/serializers/#{name}_serializer.rb"
+      def target_dir
+        'api/serializers'
+      end
+
+      def target_name
+        "#{name}_serializer.rb"
       end
 
       def spec_target
-        "spec/serializers/#{name}_serializer_spec.rb"
+        target(directory: 'spec/serializers', name: "#{name}_serializer_spec.rb")
+      end
+
+      def policy_file
+        File.join(['policies', namespace, "#{name}_policy"].compact)
       end
 
       def create_serializer
         content = render(template, opts)
+        content = wrap_in_module(content, module_name)
         write_output(target, content)
       end
 
       def create_serializer_spec
         content = render(spec_template, opts)
+        content = wrap_in_module(content, module_name, search: "describe #{serializer_class_name}")
         write_output(spec_target, content)
       end
 
       def attributes
-        args[1..-1].map { |attr| ":#{attr}" }
+        args[1..-1]
+      end
+
+      def attribute_names
+        attributes.map { |arg| arg.split(':').first }
       end
 
       def attributes_with_doc
-        attributes.map do |attr|
-          [
-            "# FIXME: Write documentation for attribute #{attr}",
-            "attribute #{attr}"
-          ]
-        end
+        attribute_names.map { |attr| ["attribute :#{attr}"] }
       end
 
-      def links
+      def link_relations
         %w(collection self edit-form 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/hal+json" \\
-            #      /doc/#{name}/rels/delete
-            #```
-            curie :doc do
-              doc_curie_uri('#{name}')
-            end
-          EOS
-        ]
+      def profile_with_doc
+        doc = <<~DOC
+          # Adds a link to the '#{resource_name}' profile and a curie. By default the
+          # curie prefix is 'doc', use the `curie_prefix` keyword argument to
+          # change this.
+          # Note: the target of the profile link and the curie will be set to
+          # `profile_uri('#{resource_name}')` resp. `doc_curie_uri('#{resource_name}')`. To
+          # create links for external profiles or curies, delete the next line
+          # and use `::link` and/or `::curie` instead.
+        DOC
+
+        doc.split("\n") << %Q(profile #{Utils.symbol_string(resource_name)})
       end
 
       def links_with_doc
@@ -104,92 +97,58 @@ module Shaf
       def collection_link
         link(
           rel: "collection",
-          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",
-          kwargs: ', embed_depth: 0'
+          uri_helper: "#{collection_name}_uri",
+          kwargs: {embed_depth: 0}
         )
       end
 
       def self_link
         link(
           rel: "self",
-          desc: "Link to this #{name}",
-          uri: "/#{plural_name}/5",
-          uri_helper: "#{name}_uri(resource)"
+          uri_helper: "#{resource_name}_uri(resource)"
         )
       end
 
       def edit_link
         link(
           rel: "edit-form",
-          desc: "Link to a form to edit this resource",
-          uri: "/#{plural_name}/5/edit",
-          uri_helper: "edit_#{name}_uri(resource)"
+          uri_helper: "edit_#{resource_name}_uri(resource)"
         )
       end
 
       def delete_link
         link(
           rel: "delete",
-          desc: "Link to delete this #{name}",
-          method: "DELETE",
-          uri: "/#{plural_name}/5",
-          uri_helper: "#{name}_uri(resource)",
-          kwargs: ", curie: :doc"
+          uri_helper: "#{resource_name}_uri(resource)",
+          kwargs: {curie: :doc}
         )
       end
 
       def create_link
         link(
           rel: "create-form",
-          desc: "Link to a form used to create new #{name} resources",
-          uri: "/#{plural_name}/form",
-          uri_helper: "new_#{name}_uri"
+          uri_helper: "new_#{resource_name}_uri"
         )
       end
 
-      def link(rel:, method: "GET", desc:, uri:, uri_helper:, kwargs: "")
+      def link(rel:, uri_helper:, kwargs: {})
+        kwargs_str = kwargs.inject('') do |s, (k,v)|
+          "#{s}, #{k}: #{Utils.symbol_or_quoted_string(v)}"
+        end
+
         <<~EOS.split("\n")
-          # Auto generated doc:  
-          # #{desc}.  
-          # Method: #{method}  
-          #{example(method, uri)}
-          link #{Utils.symbol_string(rel)}#{kwargs} do
+          link #{Utils.symbol_string(rel)}#{kwargs_str} do
             #{uri_helper}
           end
         EOS
       end
 
-      def example(method, uri)
-        curl_args = +'-H "Authorization: abcdef \\"'
-        case method
-        when "POST"
-          curl_args << "\n#      -d@payload \\"
-        when "PUT"
-          curl_args << "\n#      -X PUT -d@payload \\"
-        when "DELETE"
-          curl_args << "\n#      -X DELETE \\"
-        end
-
-        <<~EOS.chomp
-          # Example:
-          # ```
-          # curl -H "Accept: application/hal+json" \\
-          #      #{curl_args}
-          #      #{uri}
-          #```
-        EOS
-      end
-
       def collection_with_doc
         <<~EOS.split("\n")
           collection of: '#{plural_name}' do
-            curie(:doc) { doc_curie_uri('#{name}') }
+            curie(:doc) { doc_curie_uri('#{resource_name}') }
 
-            link :self, #{plural_name}_uri
+            link :self, #{collection_name}_uri
             link :up, root_uri
 
             #{create_link.join("\n  ")}
@@ -200,23 +159,30 @@ module Shaf
       def opts
         {
           name: name,
-          class_name: "#{model_class_name}Serializer",
+          resource_name: resource_name,
+          collection_name: collection_name,
+          class_name: serializer_class_name,
           model_class_name: model_class_name,
           policy_class_name: policy_class_name,
-          policy_name: "#{name}_policy",
-          attributes: attributes,
-          links: links,
+          policy_file: policy_file,
+          attribute_names: attribute_names,
+          link_relations: link_relations,
+          profile_with_doc: profile_with_doc,
           attributes_with_doc: attributes_with_doc,
-          curies_with_doc: curies_with_doc,
           links_with_doc: links_with_doc,
           collection_with_doc: collection_with_doc
         }
       end
 
       def create_policy
-        policy_args = ["policy", name, *args[1..-1]]
+        policy_args = ["policy", name_arg, *attribute_names]
         Generator::Factory.create(*policy_args, **options).call
       end
+
+      def create_profile
+        profile_args = ["profile", name_arg, *attributes]
+        Generator::Factory.create(*profile_args, **options).call
+      end
     end
   end
 end

data/lib/shaf/generator/templates/api/controller.rb.erb

@@ -4,45 +4,45 @@ class <%= controller_class_name %> < BaseController
 
   authorize_with <%= policy_class_name %>
 
-  resource_uris_for :<%= name %>
+  resource_uris_for :<%= name %><%= namespace ? ", namespace: '#{namespace}'" : "" %>
 
-  get :<%= plural_name %>_path do
+  get :<%= collection_name %>_path do
     authorize! :read
     collection = paginate(<%= model_class_name %>.order(:created_at).reverse)
     respond_with_collection collection, serializer: <%= serializer_class_name %>
   end
 
-  get :new_<%= name %>_path do
+  get :new_<%= resource_name %>_path do
     authorize! :read
     cache_control(:private, http_cache_max_age: :short)
     respond_with create_form
   end
 
-  post :<%= plural_name %>_path do
+  post :<%= collection_name %>_path do
     authorize! :write
     <%= name %> = <%= model_class_name %>.create(<%= name %>_params)
-    headers('Location' => <%= name %>_uri(<%= name %>))
+    headers('Location' => <%= resource_name %>_uri(<%= name %>))
     respond_with <%= name %>, status: 201
   end
 
-  get :<%= name %>_path do
+  get :<%= resource_name %>_path do
     authorize! :read
     respond_with <%= name %>
   end
 
-  get :edit_<%= name %>_path do
+  get :edit_<%= resource_name %>_path do
     authorize! :write
     cache_control(:private, http_cache_max_age: :short)
     respond_with edit_form
   end
 
-  put :<%= name %>_path do
+  put :<%= resource_name %>_path do
     authorize! :write
     <%= name %>.update(<%= name %>_params)
     respond_with <%= name %>
   end
 
-  delete :<%= name %>_path do
+  delete :<%= resource_name %>_path do
     authorize! :write
     <%= name %>.destroy
     status 204
@@ -62,15 +62,15 @@ class <%= controller_class_name %> < BaseController
 
   def create_form
     <%= model_class_name %>.create_form.tap do |form|
-      form.self_link = new_<%= name %>_uri
-      form.href = <%= plural_name %>_uri
+      form.self_link = new_<%= resource_name %>_uri
+      form.href = <%= collection_name %>_uri
     end
   end
 
   def edit_form
     <%= name %>.edit_form.tap do |form|
-      form.self_link = edit_<%= name %>_uri(<%= name %>)
-      form.href = <%= name %>_uri(<%= name %>)
+      form.self_link = edit_<%= resource_name %>_uri(<%= name %>)
+      form.href = <%= resource_name %>_uri(<%= name %>)
     end
   end
 end

data/lib/shaf/generator/templates/api/forms.rb.erb

@@ -4,12 +4,12 @@ class <%= class_name %>
   forms_for(<%= model_class_name %>) do
     <%= fields.join("\n    ") %>
 
-    create do
+    create_form do
       title 'Create <%= model_class_name %>'
       name  'create-<%= model_name %>'
     end
 
-    edit do
+    edit_form do
       instance_accessor
       title 'Update <%= model_class_name %>'
       name  'update-<%= model_name %>'

data/lib/shaf/generator/templates/api/model.rb.erb

@@ -1,4 +1,4 @@
-class <%= class_name %> < Sequel::Model
+class <%= class_name %> < Sequel::Model(:<%= table_name %>)
 
 end
 

data/lib/shaf/generator/templates/api/policy.rb.erb

@@ -8,9 +8,9 @@ class <%= policy_class_name %> < BasePolicy
 
   <%= attributes.join("\n  ") %>
 
-  link :collection
+  link :collection, :up, :proflie
 
-  link :'create-form', :'edit-form', :delete do
+  link :create_form, :edit_form, :delete do
     write?
   end
 

data/lib/shaf/generator/templates/api/profile.rb.erb

@@ -0,0 +1,16 @@
+module Profiles
+  class <%= profile_class_name %> < Shaf::Profile
+    name '<%= resource_name %>'
+
+    doc 'FIXME: replace this with a description of the <%= profile_name %> profile'
+
+    use :delete, from: Shaf::Profiles::ShafBasic
+
+  <% attributes.each do |name, type| %>
+    attribute :<%= name %>,
+              type: '<%= type %>',
+              doc: 'FIXME: Write documentation for <%= name %>'
+
+  <% end %>
+  end
+end