shaf 1.6.0 → 3.0.0

data/lib/shaf/formable/builder.rb

@@ -1,11 +1,56 @@
+require 'forwardable'
 require 'shaf/formable/form'
+require 'shaf/immutable_attr'
 
 module Shaf
   module Formable
     class Builder
-      InstanceAccessorType = Struct.new(:prefill?)
       DELEGATES = %i[title name action method type submit fields].freeze
 
+      class FormWrapper
+        extend Forwardable
+        extend Shaf::ImmutableAttr
+
+        attr_accessor :instance_accessor
+        immutable_reader :form
+
+        WRITER_DELEGATES = DELEGATES.map { |method| :"#{method}=" }
+        def_delegators :@form, :add_field, *WRITER_DELEGATES
+
+        def initialize(form, method_name: nil, instance_accessor: nil)
+          @form = form&.dup || Formable::Form.new
+          @method_name = method_name
+          @form.action = action_from(method_name) unless @form.action
+          @instance_accessor = instance_accessor
+        end
+
+        def action_from(method_name)
+          return unless method_name
+
+          (method_name.to_s.delete_suffix('_form')).to_sym
+        end
+
+        def method_name
+          name = @method_name || form.action
+
+          if name.nil?
+            nil
+          elsif name.to_s.end_with? '_form'
+            name.to_sym
+          else
+            :"#{name}_form"
+          end
+        end
+
+        def instance_accessor?
+          [:empty, :prefill].include? instance_accessor
+        end
+
+        def prefill?
+          instance_accessor == :prefill
+        end
+      end
+
       attr_reader :forms
 
       def initialize(&block)
@@ -15,48 +60,42 @@ module Shaf
         exec_with_form(block)
       end
 
-      def instance_accessor_for(form)
-        @instance_accessors[form.action]
-      end
-
       private
 
-      attr_reader :form
+      attr_reader :current
 
-      def exec_with_form(block, action: nil)
-        current, @form = form, new_form
-        form.action = action if action
+      def exec_with_form(block, method_name: nil)
+        prev, @current = current, new_form(method_name)
         instance_exec(&block)
       ensure
-        @form = current
+        @current = prev
       end
 
-      def new_form
-        (form&.dup || Formable::Form.new).tap { |f| @forms << f }
+      def new_form(method_name)
+        FormWrapper.new(current&.form, method_name: method_name).tap { |f| @forms <<  f }
       end
 
       def instance_accessor(prefill: true)
-        acc = InstanceAccessorType.new(prefill)
-        @instance_accessors[form.action] = acc
+        current.instance_accessor = prefill ? :prefill : :empty
       end
 
       DELEGATES.each do |name|
         define_method(name) do |arg|
-          form.send(:"#{name}=", arg)
+          current.send(:"#{name}=", arg)
         end
       end
 
       def field(name, opts = {})
-        form.add_field(name, opts)
+        current.add_field(name, opts)
       end
 
       def method_missing(method, *args, &block)
         return super unless args.empty? && block
-        exec_with_form(block, action: method)
+        exec_with_form(block, method_name: method)
       end
 
-      def respond_to_missing?(*)
-        true
+      def respond_to_missing?(method, _include_private = false)
+        method.to_s.end_with?('_form') ? true : super
       end
     end
   end

data/lib/shaf/formable/form.rb

@@ -12,14 +12,15 @@ module Shaf
       DEFAULT_SUBMIT = 'save'.freeze
 
       attr_accessor :resource
-      immutable_accessor :title, :name, :href, :type, :submit, :self_link
-      immutable_reader :fields, :action
+      attr_writer :name, :action
+      immutable_accessor :title, :href, :type, :submit, :self_link
+      immutable_reader :fields
 
       def initialize(params = {})
         @title = params[:title]
         @action = params[:action]
-        @name = params[:name]&.to_sym || name_from(@action)
-        @method = params[:method] ||= http_method_from(@action)
+        @name = params[:name]
+        @method = params[:method]
         @type = params[:type] || DEFAULT_TYPE
         @submit = params[:submit] || DEFAULT_SUBMIT
         @fields = (params[:fields] || {}).map do |name, args|
@@ -27,23 +28,25 @@ module Shaf
         end
       end
 
+      def name
+        (@name || name_from(action))&.to_sym
+      end
+
       def method=(http_method)
         @method = http_method.to_s.upcase
       end
 
       def method
-        return unless @method
-        @method.to_s.upcase
+        _method = @method || http_method_from(action)
+        _method.to_s.upcase if _method
       end
 
       def fields=(fields)
         @fields = fields.map { |name, args| Field.new(name, args) }
       end
 
-      def action=(action)
-        @action = action
-        @name ||= name_from action
-        @method ||= http_method_from action
+      def action
+        @action&.to_sym
       end
 
       def add_field(name, opts)
@@ -112,7 +115,7 @@ module Shaf
       end
 
       def submit_element
-        %Q(<div class="form--input-group"><input type="submit" class="button" value="Submit"</div>)
+        %Q(<div class="form--input-group"><input type="submit" class="button" value="#{submit}"</div>)
       end
     end
   end

data/lib/shaf/formable.rb

@@ -3,44 +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)
-      return unless defined? $logger
-
-      $logger.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

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'erb'
+require 'file_transactions'
 require 'shaf/generator/helper'
 
 module Shaf
@@ -22,6 +23,10 @@ module Shaf
           @usage = str || block
         end
 
+        def identified_by
+          @identifiers
+        end
+
         def options(option_parser, options); end
       end
 
@@ -32,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
@@ -55,10 +114,32 @@ 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)
-        dir = File.dirname(file)
-        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
-        File.write(file, content)
+        FileTransactions::CreateFileCommand.execute(file) { content }
         puts "Added:      #{file}"
       end
     end

data/lib/shaf/generator/controller.rb

@@ -1,3 +1,5 @@
+require 'file_transactions'
+
 module Shaf
   module Generator
     class Controller < Base
@@ -11,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)
@@ -42,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
 
@@ -64,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
@@ -81,31 +79,21 @@ module Shaf
         end
         added = false
         content = []
-        File.readlines(file).reverse_each do |line|
-          if match = !added && line.match(/^(\s*)link /)
-            content.unshift link_content(match[1].to_s)
-            added = true
+        FileTransactions::ChangeFileCommand.execute(file) do
+          File.readlines(file).reverse_each do |line|
+            if match = !added && line.match(/^(\s*)link /)
+              content.unshift link_content(match[1].to_s)
+              added = true
+            end
+            content.unshift(line)
           end
-          content.unshift(line)
+          File.open(file, 'w') { |f| f.puts content }
+          puts "Modified:   #{file}"
         end
-        File.open(file, 'w') { |f| f.puts content }
-        puts "Modified:   #{file}"
       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/doc.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Generator
+    class Doc < Base
+      identifier %r{\Adoc(\b|umentation)\Z}
+      usage 'generate doc [SERIALIZER_NAME] [..]'
+
+      def call
+        require 'shaf/yard'
+        name = String(args[0]).strip
+        Shaf::Yard::Parser.call(name: name)
+        YARD::Templates::Engine.render(template: :api_doc, format: :html)
+      end
+    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,18 +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/helper.rb

@@ -10,7 +10,8 @@ module Shaf
 
       def print(lines, indent_level = 2)
         strip_blank(lines).inject do |result, line|
-          result + "\n#{i(indent_level) unless line.empty?}#{line}"
+          indent = i(indent_level) unless line.empty?
+          result + "\n#{indent}#{line}"
         end.chomp
       end
 

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
@@ -42,9 +50,13 @@ module Shaf
 
         def column_def(str, create: true)
           _, col_type = str.split(':')
-          type = Type.find(col_type)
-          raise "No supported DB column types for: #{col_type}" unless type
-          type.build(str, create: create, alter: !create)
+          type = Types.find(col_type)
+          return type.build(str, create: create, alter: !create) if type
+
+          raise <<~ERR
+            No supported DB column types for: #{col_type}
+            Supported types: #{Types.all.map(&:name).join(', ')}
+          ERR
         end
 
         def target(name)

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/migration/type.rb

@@ -4,34 +4,12 @@ module Shaf
       class Type
         attr_reader :name, :create_template, :alter_template, :validator
 
-        class << self
-          def add(name, **kwargs)
-            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
-
-          private
-
-          def types
-            @types ||= {}
-          end
-
-          def clear
-            @types.clear if defined? @types
-          end
-        end
-
         def initialize(str, create_template:, alter_template:, validator: nil)
           @name = str.downcase.to_sym
-          @create_template = create_template
-          @alter_template = alter_template
-          @validator = validator
+          @create_template = create_template.freeze
+          @alter_template = alter_template.freeze
+          @validator = validator.freeze
+          freeze
         end
 
         def build(str, create: false, alter: false)