shaf 0.4.1 → 0.5.0

data/lib/shaf/generator/migration.rb

@@ -1,5 +1,3 @@
-require 'date'
-
 module Shaf
   module Generator
     module Migration
@@ -20,119 +18,11 @@ module Shaf
           raise Command::ArgumentError, e.message
         end
       end
-
-      class Base
-        DB_COL_TYPES = {
-          integer:    ['Integer :%s',             'add_column :%s, Integer'],
-          varchar:    ['String %s',               'add_column :%s, String'],
-          string:     ['String :%s',              'add_column :%s, String'],
-          text:       ['String :%s, text: true',  'add_column :%s, String, text: true'],
-          blob:       ['File :%s',                'add_column :%s, File'],
-          bigint:     ['Bignum :%s',              'add_column :%s, Bignum'],
-          double:     ['Float :%s',               'add_column :%s, Float'],
-          numeric:    ['BigDecimal :%s',          'add_column :%s, BigDecimal'],
-          date:       ['Date :%s',                'add_column :%s, Date'],
-          timestamp:  ['DateTime :%s',            'add_column :%s, DateTime'],
-          time:       ['Time :%s',                'add_column :%s, Time'],
-          bool:       ['TrueClass :%s',           'add_column :%s, TrueClass'],
-          boolean:    ['TrueClass :%s',           'add_column :%s, TrueClass'],
-          index:      ['index :%s, unique: true', 'add_index :%s'],
-        }
-
-        REGEXP_DB_TYPES = {
-          /\Aforeign_key\((\w+)\)/ => ['foreign_key :%s, :\1', 'add_foreign_key :%s, :\1'],
-        }
-
-        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
-          result = DB_COL_TYPES[type.to_sym]
-          result ||= REGEXP_DB_TYPES.each do |pattern, strings|
-            m = pattern.match(type) or next
-            break strings.map { |a| replace_backreferences(m, a) }
-          end
-          raise "Column type '#{type}' not supported" unless result
-          result
-        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 replace_backreferences(match, str)
-          groups = match.size
-          (1...groups).inject(str) do |s, i|
-            s.gsub("\\#{i}", match[i])
-          end
-        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/base'
 require 'shaf/generator/migration/add_column'
 require 'shaf/generator/migration/add_index'
 require 'shaf/generator/migration/create_table'

data/lib/shaf/generator/serializer.rb

@@ -69,7 +69,7 @@ module Shaf
       end
 
       def links
-        %w(doc:up self doc:create-form doc:edit-form doc:edit doc:delete)
+        %w(doc:up self doc:edit-form doc:delete)
       end
 
       def curies_with_doc
@@ -83,7 +83,7 @@ module Shaf
             # Example:
             # ```
             # curl -H "Accept: application/hal+json" \\
-            #      /doc/#{name}/rels/edit
+            #      /doc/#{name}/rels/delete
             #```
             curie :doc do
               doc_curie_uri('#{name}')
@@ -96,9 +96,7 @@ module Shaf
         [
           collection_link,
           self_link,
-          new_link,
           edit_link,
-          update_link,
           delete_link,
         ]
       end
@@ -123,15 +121,6 @@ module Shaf
         )
       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",
@@ -141,16 +130,6 @@ module Shaf
         )
       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",
@@ -194,38 +173,13 @@ module Shaf
         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
+            link :'doc:create-form', new_#{name}_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
@@ -239,11 +193,9 @@ module Shaf
           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

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

@@ -14,6 +14,7 @@ class <%= controller_class_name %> < BaseController
 
   get :new_<%= name %>_uri do
     authorize! :read
+    cache_control(:private, http_cache_max_age: :short)
     respond_with create_form
   end
 
@@ -31,6 +32,7 @@ class <%= controller_class_name %> < BaseController
 
   get :edit_<%= name %>_uri do
     authorize! :read
+    cache_control(:private, http_cache_max_age: :short)
     respond_with edit_form
   end
 

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

@@ -1,5 +1,6 @@
-class <%= policy_class_name %>
-  include HALPresenter::Policy::DSL
+require 'policies/base_policy'
+
+class <%= policy_class_name %> < BasePolicy
 
   # Auto generated policy: Update this file to suite your API!
  

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

@@ -1,8 +1,7 @@
+require 'serializers/base_serializer'
 require 'policies/<%= policy_name %>'
 
-class <%= class_name %>
-  extend HALPresenter
-  extend Shaf::UriHelper
+class <%= class_name %> < BaseSerializer
 
   model <%= model_class_name %>
   policy <%= policy_class_name %>
@@ -15,9 +14,6 @@ class <%= class_name %>
   <% links_with_doc.each do |link| %>
   <%= link.join("\n  ") %>
   <% end %>
-  <% embeds_with_doc.each do |embed| %>
-  <%= embed.join("\n  ") %>
-  <% end %>
   <% if collection_with_doc %>
   <%= collection_with_doc.join("\n  ") %>
   <% end %>

data/lib/shaf/generator/templates/spec/integration_spec.rb.erb

@@ -34,21 +34,21 @@ describe <%= model_class_name %>, type: :integration do
   it "can create <%= plural_name %>" do
     get <%= plural_name %>_uri
 
-    embedded :'doc:create-form' do
-      links[:self][:href].must_equal new_<%= name %>_uri
-      attributes[:href].must_equal <%= plural_name %>_uri
-      attributes[:method].must_equal "POST"
-      attributes[:name].must_equal "create-<%= name %>"
-      attributes[:title].must_equal "Create <%= model_class_name %>"
-      attributes[:type].must_equal "application/json"
-      attributes[:fields].size.must_equal <%= params.size %>
-
-      payload = fill_form attributes[:fields]
-      post attributes[:href], payload
-      status.must_equal 201
-      link_rels.must_include(:self)
-      headers["Location"].must_equal links[:self][:href]
-    end
+    link_rels.must_include(:'doc:create-form')
+    follow_rel :'doc:create-form'
+    links[:self][:href].must_equal new_<%= name %>_uri
+    attributes[:href].must_equal <%= plural_name %>_uri
+    attributes[:method].must_equal "POST"
+    attributes[:name].must_equal "create-<%= name %>"
+    attributes[:title].must_equal "Create <%= model_class_name %>"
+    attributes[:type].must_equal "application/json"
+    attributes[:fields].size.must_equal <%= params.size %>
+
+    payload = fill_form attributes[:fields]
+    post attributes[:href], payload
+    status.must_equal 201
+    link_rels.must_include(:self)
+    headers["Location"].must_equal links[:self][:href]
 
     get <%= plural_name %>_uri
     status.must_equal 200
@@ -71,22 +71,22 @@ describe <%= model_class_name %>, type: :integration do
     <%= name %> = <%= model_class_name %>.create
     get <%= name %>_uri(<%= name %>)
     status.must_equal 200
-    link_rels.must_include(:'doc:edit-form')
 
-    embedded :'doc:edit-form' do
-      links[:self][:href].must_equal edit_<%= name %>_uri(<%= name %>)
-      attributes[:href].must_equal <%= name %>_uri(<%= name %>)
-      attributes[:method].must_equal "PUT"
-      attributes[:name].must_equal "update-<%= name %>"
-      attributes[:title].must_equal "Update <%= model_class_name %>"
-      attributes[:type].must_equal "application/json"
-      attributes[:fields].size.must_equal <%= params.size %>
-
-      payload = fill_form attributes[:fields]
-      put attributes[:href], payload
-      status.must_equal 200
-      link_rels.must_include(:self)
-    end
+    link_rels.must_include(:'doc:edit-form')
+    follow_rel :'doc:edit-form'
+
+    links[:self][:href].must_equal edit_<%= name %>_uri(<%= name %>)
+    attributes[:href].must_equal <%= name %>_uri(<%= name %>)
+    attributes[:method].must_equal "PUT"
+    attributes[:name].must_equal "update-<%= name %>"
+    attributes[:title].must_equal "Update <%= model_class_name %>"
+    attributes[:type].must_equal "application/json"
+    attributes[:fields].size.must_equal <%= params.size %>
+
+    payload = fill_form attributes[:fields]
+    put attributes[:href], payload
+    status.must_equal 200
+    link_rels.must_include(:self)
   end
 
   it "<%= plural_name %> can be deleted" do

data/lib/shaf/generator.rb

@@ -1,6 +1,3 @@
-require 'fileutils'
-require 'erb'
-require 'ostruct'
 require 'shaf/registrable_factory'
 
 module Shaf
@@ -8,63 +5,10 @@ module Shaf
     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
-
-        def options(option_parser, options); end
-      end
-
-      def initialize(*args)
-        @args = args.dup
-      end
-
-      def call(options = {}); 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/base'
 require 'shaf/generator/controller'
 require 'shaf/generator/migration'
 require 'shaf/generator/model'

data/lib/shaf/helpers/cache_control.rb

@@ -0,0 +1,21 @@
+module Shaf
+  module CacheControl
+
+    def cache_control(*args, **kwargs)
+      return unless Shaf::Settings.http_cache
+      set_max_age(kwargs)
+      super(*args, **kwargs)
+    end
+
+    private
+
+    def set_max_age(kwargs)
+      max_age = kwargs[:http_cache_max_age] or return
+      if max_age.is_a? Symbol
+        key = "http_cache_max_age_#{max_age}".to_sym
+        max_age = Settings.respond_to?(key) ? Settings.send(key) : 86400
+        kwargs[:http_cache_max_age] = max_age
+      end
+    end
+  end
+end

data/lib/shaf/helpers.rb

@@ -1,13 +1,15 @@
-require 'shaf/helpers/payload'
+require 'shaf/helpers/cache_control'
 require 'shaf/helpers/json_html'
 require 'shaf/helpers/paginate'
+require 'shaf/helpers/payload'
 
 module Shaf
   def self.helpers
     [
-      Payload,
+      CacheControl,
       JsonHtml,
       Paginate,
+      Payload,
     ]
   end
 end

data/lib/shaf/rake/db.rb

@@ -73,7 +73,7 @@ Shaf::DbTask.new(:seed, description: "Seed the Database") do
 
   if Dir.exist? "db/seeds"
     Dir['db/seeds/**/*.rb'].each do |file|
-      require file.sub(".rb", "")
+      require file.sub(/.rb\Z/, "")
     end
   end
 end

data/lib/shaf/upgrade/manifest.rb

@@ -3,22 +3,39 @@ require 'yaml'
 module Shaf
   module Upgrade
     class Manifest
-      attr_reader :target_version, :patches
+      attr_reader :target_version, :files
 
-      def initialize(target_version:, patches: {})
+      def initialize(target_version:, patches: nil, add: nil, drop: nil)
         @target_version = target_version
-        @patches = build_patterns(patches)
+        @files = {}
+        @files[:patch] = build_patterns(patches)
+        @files[:add] = add || {}
+        @files[:drop] = (drop || []).map { |d| Regexp.new(d) }
       end
 
+      def patch_for(file)
+        first_match = files[:patch].find { |_, pattern| file =~ pattern }
+        (first_match || []).first
+      end
+
+      def drop?(file)
+        files[:drop].any? { |pattern| file =~ pattern }
+      end
+
+      def stats
+        "Add: #{files[:add].size}, " \
+          "Del: #{files[:drop].size}, " \
+          "Patch: #{files[:patch].size}"
+      end
+
+      private
+
       def build_patterns(patches)
+        return {} unless patches
         patches.each_with_object({}) do |(chksum, pattern), hash|
-          hash[chksum] = /#{pattern}/
+          hash[chksum] = Regexp.new(pattern)
         end
       end
-
-      def patch_name_for(file)
-        @patches.select { |_, pattern| pattern =~ file }.keys.first
-      end
     end
   end
 end
@@ -29,3 +46,7 @@ end
 # patches:
 #   cd5b0bf61070a9fd57e60c45e9aaf64a: config/database.rb
 #   59783ecfa5f41b84c6fad734e7aa6a1d: Rakefile
+# add:
+#   8ece24b8c440675bd3d188155909431c: api/policies/base_policy.rb
+# drop:
+# - api/policies/base_policy.rb

data/lib/shaf/upgrade/package.rb

@@ -3,6 +3,7 @@ require 'zlib'
 require 'set'
 require 'digest'
 require 'open3'
+require 'fileutils'
 
 module Shaf
   module Upgrade
@@ -13,8 +14,8 @@ module Shaf
       class VersionNotFoundError < UpgradeError; end
       class VersionConflictError < UpgradeError; end
       class ManifestNotFoundError < UpgradeError; end
-      class MissingPatchError < UpgradeError; end
-      class PatchNotInManifestError < UpgradeError; end
+      class MissingFileError < UpgradeError; end
+      class FileNotInManifestError < UpgradeError; end
       class BadChecksumError < UpgradeError; end
 
       UPGRADE_FILES_PATH = File.join(Utils.gem_root, 'upgrades').freeze
@@ -50,10 +51,10 @@ module Shaf
         end
       end
 
-      def initialize(version)
+      def initialize(version, manifest = nil, files = {})
         @version = Version.new(version)
-        @manifest = nil
-        @patches = {}
+        @manifest = manifest
+        @files = files
       end
 
       def load
@@ -74,22 +75,15 @@ module Shaf
       end
 
       def apply(dir = nil)
-        files_in(dir).all? do |file|
-          name = @manifest.patch_name_for(file) # returns nil when file
-          next true unless name                 # shouldn't be patched
-          patch = @patches[name]
-          apply_patch(file, patch)
-        end
+        apply_patches(dir)
+        apply_additions
+        apply_drops(dir)
       end
 
       def to_s
-        if @manifest.nil?
-          "Shaf::Upgrade::Package for version #{@version}"
-        else
-          count = @patches.size
-          count_str = "#{count} patch#{count == 1 ? "" : "es"}" 
-          "Shaf::Upgrade::Package for version #{@version}, containing #{count_str}"
-        end
+        str = "Shaf::Upgrade::Package for version #{@version}"
+        return str if @manifest.nil?
+        "#{str} (#{@manifest.stats})"
       end
 
       private
@@ -107,15 +101,17 @@ module Shaf
         if filename == MANIFEST_FILENAME
           parse_manifest content
         else
-          @patches[filename] = content
+          @files[filename] = content
         end
       end
 
       def parse_manifest(content)
-        h = YAML.safe_load(content)
+        hash = YAML.safe_load(content)
         @manifest = Manifest.new(
-          target_version: h['target_version'],
-          patches: h['patches']
+          target_version: hash["target_version"],
+          patches: hash["patches"],
+          add: hash["add"],
+          drop: hash["drop"]
         )
       end
 
@@ -123,12 +119,18 @@ module Shaf
         raise ManifestNotFoundError unless @manifest
         raise VersionConflictError unless @version == @manifest.target_version
 
-        from_manifest = @manifest.patches.keys.to_set
-        from_file = @patches.keys.to_set
-        raise MissingPatchError if from_file < from_manifest
-        raise PatchNotInManifestError if from_manifest < from_file
+        from_file = @files.keys.to_set
 
-        @patches.each do |md5, content|
+        manifest_patches = @manifest.files[:patch].keys.to_set
+        raise MissingFileError if from_file < manifest_patches
+
+
+        to_add = @manifest.files[:add].keys.to_set
+        raise MissingFileError if from_file < to_add
+
+        raise FileNotInManifestError if (manifest_patches + to_add) < from_file
+
+        @files.each do |md5, content|
           raise BadChecksumError unless Digest::MD5.hexdigest(content) == md5
         end
 
@@ -140,6 +142,15 @@ module Shaf
         Dir["#{dir}**/*"]
       end
 
+      def apply_patches(dir = nil)
+        files_in(dir).all? do |file|
+          name = @manifest.patch_for(file) # returns nil when file
+          next true unless name            # shouldn't be patched
+          patch = @files[name]
+          apply_patch(file, patch)
+        end
+      end
+
       def apply_patch(file, patch)
         success = nil
         Open3.popen3('patch', file, '-r', '-') do |i, o, e, t|
@@ -153,6 +164,19 @@ module Shaf
         success
       end
 
+      def apply_additions
+        @manifest.files[:add].each do |chksum, filename|
+          content = @files[chksum]
+          FileUtils.mkdir_p File.dirname(filename)
+          File.open(filename, 'w') { |file| file.write(content) }
+        end
+      end
+
+      def apply_drops(dir = nil)
+        files_in(dir).map do |file|
+          File.unlink(file) if @manifest.drop?(file)
+        end
+      end
     end
   end
 end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end