shaf 2.1.0 → 3.0.1

data/lib/shaf/formable.rb

@@ -3,43 +3,30 @@ require 'shaf/formable/builder'
 module Shaf
   module Formable
     def self.add_class_reader(clazz, name, form)
-      clazz.define_singleton_method(name) { form }
+      clazz.define_singleton_method(name) { form.dup }
     end
 
     def self.add_instance_reader(clazz, name, form, prefill)
       clazz.define_method(name) do
-        form.tap do |f|
+        form.dup.tap do |f|
           f.resource = self
           f.fill! if prefill
         end
       end
     end
 
-    # Deprecated legacy way of specifying forms inside models
-    def form(&block)
-      forms_for(self, &block)
-
-      Shaf.log.info <<~MSG
-
-
-        DEPRECATED method ::form in #{self}
-        Declare forms in a separate class extending Shaf::Formable with the class method forms_for!
-      MSG
-    end
-
-    # New way of writing forms in a separate class/file
     def forms_for(clazz, &block)
       builder = Formable::Builder.new(&block)
-      builder.forms.each do |form|
-        next unless form.action
-        method_name = "#{form.action}_form"
+      builder.forms.each do |form_wrapper|
+        method_name = form_wrapper.method_name
+        next unless method_name
 
-        Formable.add_class_reader(clazz, method_name, form.dup)
+        form = form_wrapper.form
 
-        if instance_accessor = builder.instance_accessor_for(form)
-          prefill_form = instance_accessor.prefill?
-          Formable.add_instance_reader(clazz, method_name, form.dup, prefill_form)
-        end
+        Formable.add_class_reader(clazz, method_name, form)
+        next unless form_wrapper.instance_accessor?
+
+        Formable.add_instance_reader(clazz, method_name, form, form_wrapper.prefill?)
       end
     end
     alias form_for forms_for

data/lib/shaf/generator/base.rb

@@ -23,6 +23,10 @@ module Shaf
           @usage = str || block
         end
 
+        def identified_by
+          @identifiers
+        end
+
         def options(option_parser, options); end
       end
 
@@ -33,6 +37,60 @@ module Shaf
 
       def call; end
 
+      def identifier
+        self.class.identified_by
+      end
+
+      private
+
+      def params
+        args[1..-1].map { |param| param.split(':')}
+      end
+
+      def name_arg
+        n = args.first || ''
+        return n unless n.empty?
+        raise Command::ArgumentError,
+          "Please provide a name when using the #{identifier} generator!"
+      end
+
+      def name
+        name_arg.split('/', 2).last
+      end
+
+      def model_class_name
+        Utils.model_name(name)
+      end
+
+      def plural_name
+        Utils.pluralize(name)
+      end
+
+      def resource_name
+        [namespace, name].compact.join('_')
+      end
+
+      def collection_name
+        [namespace, plural_name].compact.join('_')
+      end
+
+      def namespace
+        names = name_arg.split('/')
+        return if names.size == 1
+
+        warn "Only a single namespaces is allowed: #{name_arg}" if names.size > 2
+
+        names.first
+      end
+
+      def module_name
+        Utils.model_name(namespace) if namespace
+      end
+
+      def target(directory: target_dir, ns: namespace, name: target_name)
+        File.join(*[directory, ns, name].compact)
+      end
+
       def template_dir
         File.expand_path('templates', __dir__)
       end
@@ -56,6 +114,30 @@ module Shaf
         raise
       end
 
+      def wrap_in_module(content, module_name, search: nil)
+        return content if module_name.nil? || module_name.empty?
+
+        indentation = '  '
+        search ||= '(class|module) \w'
+        lines = []
+        added = false
+
+        content.split("\n").each do |line|
+          unless added
+            if m = line.match(/\A(\s*)#{search}/)
+              lines << "#{m[1]}module #{module_name}"
+              added = true
+            end
+          end
+
+          line.prepend(indentation) if added
+          lines << line
+        end
+
+        lines << 'end' if added
+        lines.join("\n")
+      end
+
       def write_output(file, content)
         FileTransactions::CreateFileCommand.execute(file) { content }
         puts "Added:      #{file}"

data/lib/shaf/generator/controller.rb

@@ -13,24 +13,7 @@ module Shaf
         add_link_to_root
       end
 
-      def params
-        args[1..-1].map { |param| param.split(':')}
-      end
-
-      def name
-        n = args.first || ''
-        return n unless n.empty?
-        raise Command::ArgumentError,
-          'Please provide a controller name when using the controller generator!'
-      end
-
-      def model_class_name
-        Utils.model_name(name)
-      end
-
-      def plural_name
-        Utils.pluralize(name)
-      end
+      private
 
       def pluralized_model_name
         Utils.pluralize(model_class_name)
@@ -44,21 +27,31 @@ module Shaf
         'spec/integration_spec.rb'
       end
 
-      def target
-        "api/controllers/#{plural_name}_controller.rb"
+      def target_dir
+        'api/controllers'
+      end
+
+      def target_name
+        "#{plural_name}_controller.rb"
       end
 
       def spec_target
-        "spec/integration/#{plural_name}_controller_spec.rb"
+        target(directory: 'spec/integration', name: "#{plural_name}_controller_spec.rb")
+      end
+
+      def policy_file
+        File.join(['policies', namespace, "#{name}_policy"].compact)
       end
 
       def create_controller
         content = render(template, opts)
+        content = wrap_in_module(content, module_name)
         write_output(target, content)
       end
 
       def create_integration_spec
         content = render(spec_template, opts)
+        content = wrap_in_module(content, module_name, search: "describe #{model_class_name}")
         write_output(spec_target, content)
       end
 
@@ -66,11 +59,14 @@ module Shaf
         {
           name: name,
           plural_name: plural_name,
+          resource_name: resource_name,
+          collection_name: collection_name,
           serializer_class_name: "#{model_class_name}Serializer",
           model_class_name: model_class_name,
           controller_class_name: "#{pluralized_model_name}Controller",
           policy_class_name: "#{model_class_name}Policy",
-          policy_file: "policies/#{name}_policy",
+          policy_file: policy_file,
+          namespace: namespace,
           params: params
         }
       end
@@ -97,19 +93,7 @@ module Shaf
       end
 
       def link_content(indentation = '')
-        <<~DOC.split("\n").map { |line| "#{indentation}#{line}" }
-
-          # Auto generated doc:  
-          # Link to the collection of #{plural_name}.  
-          # Method: GET  
-          # Example:
-          # ```
-          # curl -H "Accept: application/hal+json" \\
-          #      -H "Authorization: abcdef" \\
-          #      /#{plural_name}
-          #```
-          link :#{plural_name}, #{plural_name}_uri
-        DOC
+        "#{indentation}link :#{plural_name}, #{collection_name}_uri"
       end
     end
   end

data/lib/shaf/generator/forms.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shaf
   module Generator
     class Forms < Base
@@ -8,17 +10,6 @@ module Shaf
         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 forms generator!'
-      end
-
-      def model_class_name
-        Utils.model_name(model_name)
-      end
-
       def class_name
         "#{model_class_name}Forms"
       end
@@ -27,19 +18,24 @@ module Shaf
         'api/forms.rb'
       end
 
-      def target
-        "api/forms/#{model_name}_forms.rb"
+      def target_dir
+        'api/forms'
+      end
+
+      def target_name
+        "#{name}_forms.rb"
       end
 
       def create_forms
         content = render(template, opts)
+        content = wrap_in_module(content, module_name)
         # FIXME: Append if file exists!
         write_output(target, content)
       end
 
       def opts
         {
-          model_name: model_name,
+          model_name: name,
           class_name: class_name,
           model_class_name: model_class_name,
           fields: fields

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

@@ -21,10 +21,6 @@ module Shaf
           "add_#{cols.join('_')}_to_#{table_name}"
         end
 
-        def table_name
-          args.first
-        end
-
         def compile_changes
           add_change add_columns_change
         end

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

@@ -16,10 +16,6 @@ module Shaf
           "add_#{column}_index_to_#{table_name}"
         end
 
-        def table_name
-          args.first
-        end
-
         def compile_changes
           add_change add_index_change
         end

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

@@ -19,6 +19,10 @@ module Shaf
           def usage(str = nil, &block)
             @usage = str || block
           end
+
+          def identified_by
+            @identifiers
+          end
         end
 
         def initialize(*args, **options)
@@ -35,6 +39,10 @@ module Shaf
           raise Command::ArgumentError, e.message
         end
 
+        def table_name
+          (args.first || '').tr('/', '_')
+        end
+
         def add_change(change)
           @changes ||= []
           @changes << change if change

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

@@ -11,10 +11,6 @@ module Shaf
           raise "Please provide a table name when generation a create table migration"
         end
 
-        def table_name
-          args.first || ""
-        end
-
         def compile_migration_name
           "create_#{table_name}_table"
         end

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

@@ -24,10 +24,6 @@ module Shaf
           add_change drop_column_change
         end
 
-        def table_name
-          args.first || ""
-        end
-
         def column
           args[1] || ""
         end

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

@@ -23,10 +23,6 @@ module Shaf
           add_change rename_column_change
         end
 
-        def table_name
-          args.first || ""
-        end
-
         def from_col
           args[1] || ""
         end

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,12 +67,12 @@ module Shaf
       end
 
       def create_serializer
-        serializer_args = %W(serializer #{model_name}) + args[1..-1]
+        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

@@ -8,23 +8,16 @@ module Shaf
         create_profile
       end
 
-      def profile_name
-        n = args.first || ""
-        return n unless n.empty?
-        raise Command::ArgumentError,
-          "Please provide a profile name when using the profile generator!"
-      end
-
-      def model_class_name
-        Utils::model_name(profile_name)
-      end
-
       def template
         'api/profile.rb'
       end
 
-      def target
-        "api/profiles/#{profile_name}.rb"
+      def target_dir
+        'api/profiles'
+      end
+
+      def target_name
+        "#{name}.rb"
       end
 
       def attributes
@@ -37,14 +30,16 @@ module Shaf
 
       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: profile_name,
+          profile_name: name,
           profile_class_name: "#{model_class_name}",
           attributes: attributes,
+          resource_name: resource_name,
         }
       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