shaf 0.1.0.beta

data/lib/shaf/formable.rb

@@ -0,0 +1,188 @@
+module Shaf
+  module Formable
+    class Field
+      attr_reader :name, :type, :value, :label
+
+      def initialize(name, params = {})
+        @name = name
+        @type = params[:type]
+        @label = params[:label]
+        @has_value = params.key? :value
+        @value = params[:value]
+      end
+
+      def has_value?
+        @has_value
+      end
+
+      def to_html
+        [
+          '<div class="form--input-group">',
+          label_element,
+          input_element,
+          '</div>'
+        ].compact.join("\n")
+      end
+      
+      private
+
+      def label_element
+        str = (label || name || "").to_s
+        %Q(<label for="#{name}" class="form--label">#{str}</label>)
+      end
+
+      def input_element
+        _value = value ? %Q( value="#{value.to_s}") : ""
+        %Q(<input type="#{type.to_s}" class="form--input" id="#{name.to_s}" name="#{name.to_s}"#{_value}>)
+      end
+    end
+
+    class Form
+
+      DEFAULT_TYPE = 'application/json'
+
+      attr_accessor :resource, :name, :title, :href, :type, :self_link
+      attr_reader :fields
+
+      def initialize(params = {})
+        @name = params[:name]
+        @title = params[:title]
+        @method = params[:method] || 'POST'
+        @type = params[:type] || DEFAULT_TYPE
+        @fields = (params[:fields] || {}).map { |name, args| Field.new(name, args) }
+      end
+
+      def method=(m)
+        @method = m.to_s.upcase
+      end
+
+      def method
+        @method.to_s.upcase
+      end
+
+      def fields=(fields)
+        @fields = fields.map { |name, args| Field.new(name, args) }
+      end
+
+      def add_field(name, opts)
+        @fields << Field.new(name, opts)
+      end
+
+      def to_html
+        form_element do
+          [
+            hidden_method_element,
+            fields.map { |f| f.to_html }.join("\n"),
+            submit_element,
+          ].compact.join("\n")
+        end
+      end
+
+      private
+
+      def form_element
+        [
+          %Q(<form class="form" method=#{method == 'GET' ? 'GET' : 'POST'}#{href ? %Q( action="#{href.to_s}") : ''}>),
+          block_given? ? yield : nil,
+          "</form>",
+        ].compact.join("\n")
+      end
+
+      def hidden_method_element
+        return if ['GET', 'POST'].include?(method)
+        %Q(<input type="hidden" name="_method" value="#{method}">)
+      end
+
+      def submit_element
+        %Q(<div class="form--input-group"><input type="submit" class="button" value="Submit"</div>)
+      end
+    end
+
+    class Builder
+      def self.call(block)
+        [
+          new(block, create: true).call,
+          new(block, edit: true).call
+        ]
+      end
+
+      attr_reader :block
+
+      def initialize(block, create: false, edit: false)
+        @block = block
+        @create = create
+        @edit = edit
+        @form = nil
+        @default_method = @create ? :post : :put
+      end
+
+      def call
+        instance_exec(&block)
+        @form
+      end
+
+      def form
+        @form ||= Form.new(method: @default_method)
+      end
+
+      def name(name)
+        form.name = name
+      end
+
+      def title(title)
+        form.title = title
+      end
+
+      def method(method)
+        form.method = method
+      end
+
+      def type(type)
+        form.type = type
+      end
+
+      def fields(fields)
+        form.fields = fields
+      end
+
+      def field(name, opts = {})
+        form.add_field(name, opts)
+      end
+
+      def create(&b)
+        return unless @create
+        call_nested_block(b)
+      end
+
+      def edit(&b)
+        return unless @edit
+        call_nested_block(b)
+      end
+
+      def call_nested_block(b)
+        old, @block = @block, b
+        call
+      ensure
+        @block = old
+      end
+    end
+
+    module ClassMethods
+      attr_reader :create_form, :edit_form
+
+      def form(&block)
+        @create_form, @edit_form = Builder.(block)
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def edit_form
+      self.class.edit_form.tap do |form|
+        form&.resource = self
+      end
+    end
+  end
+end

data/lib/shaf/generator.rb

@@ -0,0 +1,69 @@
+require 'fileutils'
+require 'erb'
+require 'ostruct'
+require 'shaf/registrable_factory'
+
+module Shaf
+  module Generator
+    class Factory
+      extend RegistrableFactory
+    end
+
+    class Base
+      attr_reader :args
+
+      class << self
+        def inherited(child)
+          Factory.register(child)
+        end
+
+        def identifier(*ids)
+          @identifiers = ids.flatten
+        end
+
+        def usage(str = nil, &block)
+          @usage = str || block
+        end
+      end
+
+      def initialize(*args)
+        @args = args.dup
+      end
+
+      def template_dir
+        File.expand_path('../generator/templates', __FILE__)
+      end
+
+      def read_template(file, directory = nil)
+        directory ||= template_dir
+        filename = File.join(directory, file)
+        filename << ".erb" unless filename.end_with?(".erb")
+        File.read(filename)
+      end
+
+      def render(template, locals = {})
+        str = read_template(template)
+        locals[:changes] ||= []
+        b = OpenStruct.new(locals).instance_eval { binding }
+        ERB.new(str, 0, '%-<>').result(b)
+      rescue SystemCallError => e
+        puts "Failed to render template #{template}: #{e.message}"
+        raise
+      end
+
+      def write_output(file, content)
+        dir = File.dirname(file)
+        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+        File.write(file, content)
+        puts "Added:      #{file}"
+      end
+    end
+  end
+end
+
+require 'shaf/generator/controller'
+require 'shaf/generator/migration'
+require 'shaf/generator/model'
+require 'shaf/generator/policy'
+require 'shaf/generator/scaffold'
+require 'shaf/generator/serializer'

data/lib/shaf/generator/controller.rb

@@ -0,0 +1,106 @@
+module Shaf
+  module Generator
+    class Controller < Base
+
+      identifier :controller
+      usage 'generate controller RESOURCE_NAME [attribute:type] [..]'
+
+      def call
+        if name.empty?
+          raise Command::ArgumentError,
+            "Please provide a controller name when using the controller generator!"
+        end
+
+        create_controller
+        create_integration_spec
+        add_link_to_root
+      end
+
+      def name
+        args.first || ""
+      end
+
+      def params
+        args[1..-1].map { |param| param.split(':')}
+      end
+
+      def plural_name
+        Utils::pluralize(name)
+      end
+
+      def template
+        'api/controller.rb'
+      end
+
+      def spec_template
+        'spec/integration_spec.rb'
+      end
+
+      def target
+        "api/controllers/#{plural_name}_controller.rb"
+      end
+
+      def spec_target
+        "spec/integration/#{plural_name}_controller_spec.rb"
+      end
+
+      def create_controller
+        content = render(template, opts)
+        write_output(target, content)
+      end
+
+      def create_integration_spec
+        content = render(spec_template, opts)
+        write_output(spec_target, content)
+      end
+
+      def opts
+        {
+          name: name,
+          plural_name: plural_name,
+          serializer_class_name: "#{name.capitalize}Serializer",
+          model_class_name: name.capitalize,
+          controller_class_name: "#{plural_name.capitalize}Controller",
+          policy_class_name: "#{name.capitalize}Policy",
+          policy_file: "policies/#{name}_policy",
+          params: params
+        }
+      end
+
+      def add_link_to_root
+        file = "api/serializers/root_serializer.rb"
+        unless File.exist? file
+          puts "Warning: file '#{file}' does not exist. "\
+            "Not adding any link to the #{plural_name} collection"
+        end
+        added = false
+        content = []
+        File.readlines(file).reverse.each do |line|
+          if match = !added && line.match(/^(\s*)link /)
+            content.unshift link_content("#{match[1]}")
+            added = true
+          end
+          content.unshift(line)
+        end
+        File.open(file, 'w') { |f| f.puts content }
+        puts "Modified:   #{file}"
+      end
+
+      def link_content(indentation = "")
+        <<~EOS.split("\n").map { |line| "#{indentation}#{line}" }
+
+          # Auto generated doc:  
+          # Link to the collection of #{plural_name}.  
+          # Method: GET  
+          # Example:
+          # ```
+          # curl -H "Accept: application/json" \\
+          #      -H "Authorization: abcdef" \\
+          #      /#{plural_name}/5
+          #```
+          link :#{plural_name}, #{plural_name}_uri
+        EOS
+      end
+    end
+  end
+end

data/lib/shaf/generator/migration.rb

@@ -0,0 +1,122 @@
+require 'date'
+
+module Shaf
+  module Generator
+    module Migration
+
+      class Factory
+        extend RegistrableFactory
+      end
+
+      class Generator < Generator::Base
+        identifier :migration
+        usage { Factory.usage }
+
+        def call
+          generator = args.empty? ? Empty.new : Factory.create(*args)
+          (target, content) = generator.call
+          write_output(target, content)
+        rescue StandardError => e
+          raise Command::ArgumentError, e.message
+        end
+      end
+
+      class Base
+        DB_COL_TYPES = {
+          integer:    ['Integer :%s', ':%s, Integer'],
+          varchar:    ['String %s', ':%s, String'],
+          string:     ['String :%s', ':%s, String'],
+          text:       ['String :%s, text: true', ':%s, String, text: true'],
+          blob:       ['File :%s', ':%s, File'],
+          bigint:     ['Bignum :%s', ':%s, Bignum'],
+          double:     ['Float :%s', ':%s, Float'],
+          numeric:    ['BigDecimal :%s', ':%s, BigDecimal'],
+          date:       ['Date :%s', ':%s, Date'],
+          timestamp:  ['DateTime :%s', ':%s, DateTime'],
+          time:       ['Time :%s', ':%s, Time'],
+          bool:       ['TrueClass :%s', ':%s, TrueClass'],
+          boolean:    ['TrueClass :%s', ':%s, TrueClass'],
+        }
+
+        attr_reader :args
+
+        class << self
+          def inherited(child)
+            Factory.register(child)
+          end
+
+          def identifier(*ids)
+            @identifiers = ids.flatten.map(&:to_s)
+          end
+
+          def usage(str = nil, &block)
+            @usage = str || block
+          end
+        end
+
+        def initialize(*args)
+          @args = args.dup
+        end
+
+        def call
+          validate_args
+          name = compile_migration_name
+          compile_changes
+          [target(name), render]
+        rescue StandardError => e
+          raise Command::ArgumentError, e.message
+        end
+
+        def add_change(change)
+          @changes ||= []
+          @changes << change if change
+        end
+
+        def db_type(type)
+          type ||= :string
+          DB_COL_TYPES[type.to_sym] or raise "Column type '#{type}' not supported"
+        end
+
+        def column_def(str, create: true)
+          name, type = str.split(':')
+          format db_type(type)[create ? 0 : 1], name.downcase
+        end
+
+        def target(name)
+          raise "Migration filename is nil" unless name
+          "db/migrations/#{timestamp}_#{name}.rb"
+        end
+
+        private
+
+        def timestamp
+          DateTime.now.strftime("%Y%m%d%H%M%S")
+        end
+
+        def add_timestamp_columns?
+          if File.exist? 'config/initializers/sequel.rb'
+            require 'config/initializers/sequel'
+            Sequel::Model.plugins.include? Sequel::Plugins::Timestamps
+          end
+        end
+
+        def render
+          <<~EOS
+            Sequel.migration do
+              change do
+                #{@changes.flatten.join("\n    ")}
+              end
+            end
+          EOS
+        end
+      end
+
+    end
+  end
+end
+
+require 'shaf/generator/migration/add_column'
+require 'shaf/generator/migration/create_table'
+require 'shaf/generator/migration/drop_column'
+require 'shaf/generator/migration/empty'
+require 'shaf/generator/migration/rename_column'