shaf 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d610f6b52c0b849399c31536099eb1aecfde8b0907ee7bb1839b3430b0ccdb12
-  data.tar.gz: '069c31284757c68cf40538cbf623e3767847420b67cef09084f7461360978508'
+  metadata.gz: 749585960501bd61a7e7f4f22c2a90c2108f86c6cf0698ec87f495bb78d87389
+  data.tar.gz: da5fc9e7f87876f12654d5ea8473e7f0cd4a9dc3daba88055a51f7aaf0a794a5
 SHA512:
-  metadata.gz: b0b6fa7cf8e841b6791bfe2aa271ce3cb752c8efd603299d56c999b8b86df0d62ff03bd8b8cf00ab215bdaab17178b8ced05af25da5f7298bd998b79c404eed4
-  data.tar.gz: dedfaac82ee3fb083733354d41e4fb1417484868afb8ab956e072bf436b6035ac02287abb3b5a82d69af77b6d91da47e6eade4463dd13f1ef1c7ff98e72a429d
+  metadata.gz: '017559afb07a1d9e142a96c09c406cd697b6c797732661c8f431a1b2803c5c9e8c9c04cd7718037638a440ad077a55eaf1b382a9cdb47687b4bef7921b6ae4c5'
+  data.tar.gz: 3d2a16944a04292fd9039b2dbe5f482950296b7f1dd853e383cdbed972f33755243b16a89b5b081f53da43d456c4b1c8f081ac31ecdbcea66fce3076b2b6ec78

data/bin/shaf

@@ -24,6 +24,9 @@ module Shaf
       STDERR.puts "This command can only be executed inside a Shaf project directory. " \
         "Please change directory and try again!"
       exit 2
+    rescue Command::CommandError => e
+      STDERR.puts "Command failed: #{e.message}\n"
+      exit 3
     end
 
     def show_help

data/lib/shaf.rb

@@ -7,3 +7,4 @@ require 'shaf/formable'
 require 'shaf/extensions'
 require 'shaf/helpers'
 require 'shaf/doc_model'
+require 'shaf/upgrade'

data/lib/shaf/api_doc/document.rb

@@ -2,7 +2,6 @@ require 'fileutils'
 require 'yaml'
 require 'redcarpet'
 require 'redcarpet/render_strip'
-require 'shaf/api_doc/comment'
 
 module Shaf
   module ApiDoc

data/lib/shaf/app.rb

@@ -10,7 +10,7 @@ module Shaf
 
       def create_instance
         @instance = Sinatra.new
-        @instance.set :port, Shaf::Settings.port || 3000
+        @instance.set :port, Settings.port || 3000
         @instance.use Shaf::Middleware::RequestId
       end
 

data/lib/shaf/command.rb

@@ -1,10 +1,12 @@
+require 'optparse'
 require 'shaf/utils'
 require 'shaf/registrable_factory'
 
 module Shaf
   module Command
 
-    class ArgumentError < StandardError; end
+    class CommandError < StandardError; end
+    class ArgumentError < CommandError; end
 
     class Factory
       extend RegistrableFactory
@@ -13,7 +15,7 @@ module Shaf
     class Base
       include Utils
 
-      attr_reader :args
+      attr_reader :args, :options
 
       class << self
         def inherited(child)
@@ -32,16 +34,31 @@ module Shaf
           STDERR.puts msg
           exit status
         end
+
+        def options(option_parser, options); end
       end
 
       def initialize(*args)
         @args = args.dup
+        @options = {}
+        parse_options!
+      end
+
+      private
+
+      def parse_options!
+        parser = OptionParser.new
+        self.class.options(parser, @options)
+        parser.parse!(args)
+      rescue OptionParser::InvalidOption => e
+        raise ArgumentError, e.message
       end
     end
   end
 end
 
 require 'shaf/command/new'
+require 'shaf/command/upgrade'
 require 'shaf/command/server'
 require 'shaf/command/console'
 require 'shaf/command/generate'

data/lib/shaf/command/generate.rb

@@ -7,9 +7,19 @@ module Shaf
       identifier %r(\Ag(en(erate)?)?\Z)
       usage Generator::Factory.usage.flatten.sort
 
+      def self.options(parser, options)
+        parser.on("-s", "--[no-]specs", "generate specs") do |s|
+          options[:specs] = s
+        end
+
+        Generator::Factory.each do |clazz|
+          clazz.options(parser, options)
+        end
+      end
+
       def call
         in_project_root do
-          Generator::Factory.create(*args).call
+          Generator::Factory.create(*args).call(options)
         end
       rescue StandardError => e
         raise Command::ArgumentError, e.message

data/lib/shaf/command/new.rb

@@ -21,7 +21,7 @@ module Shaf
         Dir.chdir(@project_name) do
           copy_templates
           create_gemfile
-          create_shaf_version_file
+          write_shaf_version
           create_ruby_version_file
         end
       end
@@ -46,11 +46,6 @@ module Shaf
         end
       end
 
-      def create_shaf_version_file
-        File.write '.shaf',
-          YAML.dump({'version' => Shaf::VERSION})
-      end
-
       def create_ruby_version_file
         File.write '.ruby-version', RUBY_VERSION
       end

data/lib/shaf/command/server.rb

@@ -5,7 +5,14 @@ module Shaf
       identifier %r(\As(erver)?\Z)
       usage 'server'
 
+      def self.options(parser, options)
+        parser.on("-p", "--port PORT", Integer, "Listen port") do |p|
+          options[:port] = p
+        end
+      end
+
       def call
+        Settings.port = options[:port] if options[:port]
         bootstrap
         App.instance.run!
       end

data/lib/shaf/command/upgrade.rb

@@ -0,0 +1,38 @@
+require 'shaf/upgrade'
+
+module Shaf
+  module Command
+    class Upgrade < Base
+
+      class UnknownShafVersionError < CommandError; end
+      class UpgradeFailedError < CommandError; end
+
+      identifier %r(\Aupgrade\Z)
+      usage 'upgrade'
+
+      def call
+        in_project_root do
+          upgrade_packages.each { |package| apply(package) }
+          puts "\nProject is up-to-date! Shaf version: #{current_version}"
+        end
+      end
+
+      def apply(package)
+        package.load.apply or raise UpgradeFailedError
+        write_shaf_version package.version.to_s
+      rescue Errno::ENOENT
+        raise UpgradeFailedError,
+          "Failed to execute system command 'patch'. Make sure that 'patch' installed!" \
+          " (E.g. `sudo apt install patch` for Ubuntu)"
+      end
+
+      def upgrade_packages
+        Shaf::Upgrade::Package.all.select { |package| package > current_version }
+      end
+
+      def current_version
+        read_shaf_version or raise UnknownShafVersionError
+      end
+    end
+  end
+end

data/lib/shaf/extensions/authorize.rb

@@ -18,12 +18,6 @@ module Shaf
   end
 
   module Helpers
-    def policy(resource)
-      return @policy if defined?(@policy) && @policy
-      user = current_user if respond_to? :current_user
-      @policy = self.class.policy_class&.new(user, resource)
-    end
-
     def authorize(action, resource = nil)
       policy(resource) or raise Authorize::NoPolicyError
       @policy.public_send method_for(action)
@@ -33,6 +27,14 @@ module Shaf
       authorize(action, resource) or raise Authorize::PolicyViolationError
     end
 
+    private
+
+    def policy(resource)
+      return @policy if defined?(@policy) && @policy
+      user = current_user if respond_to? :current_user
+      @policy = self.class.policy_class&.new(user, resource)
+    end
+
     def method_for(action)
       return action if action.to_s.end_with? '?'
       "#{action}?".to_sym

data/lib/shaf/extensions/resource_uris.rb

@@ -54,10 +54,53 @@ module Shaf
   # edit_book_uri_template         => /books/:id/edit
   #
   class CreateUriMethods
+
+    # Resources should never be nested more than 1 level deep.
+    MAX_NESTING_DEPTH = 1
+
+    class UriTemplateNestingError < StandardError
+      def initialize(msg = nil)
+        msg ||= "Uri templates only supports a nesting depth of #{MAX_NESTING_DEPTH}"
+        super(msg)
+      end
+    end
+
+    class UriTemplateVariableError < StandardError
+      def initialize(msg = nil)
+        msg ||= "Mismatch between uri templates and resources"
+        super(msg)
+      end
+    end
+
+    class << self
+      def resource_helper_uri(template_uri, *resources, query)
+        uri = replace_templates(template_uri, *resources)
+        query_string = MethodBuilder.query_string(query)
+        "#{uri}#{query_string}".freeze
+      end
+
+      def replace_templates(template_uri, *resources)
+        symbols = MethodBuilder.extract_symbols(template_uri)
+        resources.compact!
+        raise UriTemplateVariableError if symbols.size != resources.size
+
+        MethodBuilder.transform_symbols(template_uri) do |segment|
+          resrc = resources.shift
+          sym = symbols.shift
+          resrc.respond_to?(sym) ? resrc.public_send(sym) : resrc
+        end
+      end
+    end
+
     def initialize(name, base: nil, plural_name: nil)
       @name = name.to_s
       @base = base&.sub(%r(/\Z), '') || ''
-      @plural_name = plural_name&.to_s || name.to_s + 's'
+      @plural_name = plural_name&.to_s || Utils::pluralize(name.to_s)
+
+      if nesting_depth > MAX_NESTING_DEPTH
+        raise UriTemplateNestingError,
+          "Too deep nesting level (max #{MAX_NESTING_DEPTH}): #{@base}"
+      end
     end
 
     def call
@@ -76,88 +119,101 @@ module Shaf
     attr_reader :name, :base, :plural_name
 
     def register_resources_uri
-      uri = "#{base}/#{plural_name}"
-      helper_name = "#{plural_name}_uri"
-
-      UriHelperMethods.register(helper_name) do |**query|
-        query_string = MethodBuilder.query_string(query)
-        "#{uri}#{query_string}".freeze
-      end
-      UriHelperMethods.register("#{helper_name}_template") { uri.freeze }
+      template_uri = "#{base}/#{plural_name}".freeze
+      helper_name = "#{plural_name}_uri".freeze
+      register(template_uri, helper_name)
     end
 
     def register_resource_uri
-      uri = "#{base}/#{plural_name}"
-      helper_name = "#{name}_uri"
-
-      UriHelperMethods.register helper_name do |resrc, **query|
-        id = resrc.is_a?(Integer) ? resrc : resrc&.id
-        query_string = MethodBuilder.query_string(query)
-
-        next "#{uri}/#{id}#{query_string}".freeze if id.is_a?(Integer)
-        raise ArgumentError,
-          "In #{helper_name}: id must be an integer! was #{id.class}"
-      end
-
-      UriHelperMethods.register "#{helper_name}_template" do
-        "#{uri}/:id".freeze
-      end
+      template_uri = "#{base}/#{plural_name}/:id".freeze
+      helper_name = "#{name}_uri".freeze
+      register(template_uri, helper_name)
     end
 
     # If a resource has the same singular and plural names, then this method
     # should be used. It will return the resource uri when a resource is given
     # as argument and the resources uri when no arguments are provided.
     def register_resource_uri_by_arg
-      uri = "#{base}/#{plural_name}"
+      resource_template_uri =   "#{base}/#{plural_name}/:id"
+      collection_template_uri = "#{base}/#{plural_name}"
       helper_name = "#{plural_name}_uri"
 
-      UriHelperMethods.register helper_name do |resrc = nil, **query|
-        query_string = MethodBuilder.query_string(query)
-
-        if resrc.nil?
-          "#{uri}#{query_string}".freeze
-        else
-          id = (resrc.is_a?(Integer) ? resrc : resrc.id).to_i
-
-          next "#{uri}/#{id}#{query_string}".freeze if id.is_a?(Integer)
-          raise ArgumentError,
-            "In #{helper_name}: id must be an integer! was #{id.class}"
-        end
-      end
-
-      UriHelperMethods.register "#{helper_name}_template" do |collection = false|
-        (collection ? uri : "#{uri}/:id").freeze
+      block = resource_or_collection_method_proc(resource_template_uri, collection_template_uri)
+      UriHelperMethods.register(helper_name, &block)
+      UriHelperMethods.register("#{helper_name}_template") do |collection = false|
+        (collection ? collection_template_uri : resource_template_uri).freeze
       end
     end
 
     def register_new_resource_uri
-      uri = "#{base}/#{plural_name}/form"
-      helper_name = "new_#{name}_uri"
-
-      UriHelperMethods.register(helper_name) do |**query|
-        query_string = MethodBuilder.query_string(query)
-        "#{uri}#{query_string}".freeze
-      end
-      UriHelperMethods.register("#{helper_name}_template") { uri.freeze }
+      template_uri = "#{base}/#{plural_name}/form".freeze
+      helper_name = "new_#{name}_uri".freeze
+      register(template_uri, helper_name)
     end
 
     def register_edit_resource_uri
-      uri = "#{base}/#{plural_name}"
-      helper_name = "edit_#{name}_uri"
+      template_uri = "#{base}/#{plural_name}/:id/edit".freeze
+      helper_name = "edit_#{name}_uri".freeze
+      register(template_uri, helper_name)
+    end
 
-      UriHelperMethods.register helper_name do |resrc, **query|
-        id = resrc.is_a?(Integer) ? resrc : resrc&.id
-        query_string = MethodBuilder.query_string(query)
+    def register(template_uri, helper_name)
+      block = resource_helper_method_proc(template_uri)
+      UriHelperMethods.register(helper_name, &block)
+      UriHelperMethods.register("#{helper_name}_template") { template_uri }
+    end
+
+    def resource_helper_method_proc(template_uri)
+      arg_count = MethodBuilder.extract_symbols(template_uri).size
 
-        next "#{uri}/#{id}/edit#{query_string}".freeze if id.is_a?(Integer)
-        raise ArgumentError,
-          "In #{helper_name}: id must be an integer! was #{id.class}"
+      case arg_count
+      when 0
+        ->(**query) do
+          CreateUriMethods.resource_helper_uri(template_uri, query)
+        end
+      when 1
+        ->(resrc, **query) do
+          CreateUriMethods.resource_helper_uri(template_uri, resrc, query)
+        end
+      when 2
+        ->(parent_resrc, resrc, **query) do
+          CreateUriMethods.resource_helper_uri(template_uri, parent_resrc, resrc, query)
+        end
+      else
+        raise UriTemplateNestingError,
+          "Too deep nesting level (max #{MAX_NESTING_DEPTH}): #{template_uri}"
       end
+    end
 
-      UriHelperMethods.register "#{helper_name}_template" do
-        "#{uri}/:id/edit".freeze
+    def resource_or_collection_method_proc(resource_template_uri, collection_template_uri)
+      case nesting_depth
+      when 0
+        ->(resrc = nil, **query) {
+          args = if resrc.nil?
+                   [collection_template_uri, query]
+                 else
+                   [resource_template_uri, resrc, query]
+                 end
+          CreateUriMethods.resource_helper_uri(*args)
+        }
+      when 1
+        ->(parent_resrc, resrc = nil, **query) {
+          args = if resrc.nil?
+                   [collection_template_uri, parent_resrc, query]
+                 else
+                   [resource_template_uri, parent_resrc, resrc, query]
+                 end
+          CreateUriMethods.resource_helper_uri(*args)
+        }
+      else
+        raise UriTemplateNestingError,
+          "Too deep nesting level (max #{MAX_NESTING_DEPTH}): #{template_uri}"
       end
     end
+
+    def nesting_depth
+      MethodBuilder.extract_symbols(base).size
+    end
   end
 
   module MethodBuilder
@@ -191,24 +247,26 @@ module Shaf
         Ruby
       end
 
-      private
-
       def extract_symbols(uri)
         uri.split('/').grep(/:.*/).map { |t| t[1..-1] }.map(&:to_sym)
       end
 
+      def transform_symbols(uri)
+        uri.split('/').map do |segment|
+          next segment unless segment.start_with? ':'
+          yield segment
+        end.join('/')
+      end
+
+      private
+
       def interpolated_uri_string(uri)
-        return uri if uri.split('/').empty?
-
-        segments = uri.split('/').map do |segment|
-          if segment.start_with? ':'
-            str = segment[1..-1]
-            "\#{#{str}.respond_to?(#{segment}) ? #{str}.#{str} : #{str}}"
-          else
-            segment
-          end
+        return uri if uri == '/'
+
+        transform_symbols(uri) do |segment|
+          str = segment[1..-1]
+          "\#{#{str}.respond_to?(#{segment}) ? #{str}.#{str} : #{str}}"
         end
-        segments.join('/')
       end
     end
   end