shaf 0.3.1 → 0.4.0

data/lib/shaf/generator.rb

@@ -24,12 +24,16 @@ module Shaf
         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

data/lib/shaf/generator/controller.rb

@@ -5,9 +5,9 @@ module Shaf
       identifier :controller
       usage 'generate controller RESOURCE_NAME [attribute:type] [..]'
 
-      def call
+      def call(options = {})
         create_controller
-        create_integration_spec
+        create_integration_spec if options[:specs]
         add_link_to_root
       end
 

data/lib/shaf/generator/migration.rb

@@ -23,19 +23,24 @@ module Shaf
 
       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'],
+          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
@@ -74,7 +79,13 @@ module Shaf
 
         def db_type(type)
           type ||= :string
-          DB_COL_TYPES[type.to_sym] or raise "Column type '#{type}' not supported"
+          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)
@@ -93,6 +104,13 @@ module Shaf
           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'
@@ -116,6 +134,7 @@ module Shaf
 end
 
 require 'shaf/generator/migration/add_column'
+require 'shaf/generator/migration/add_index'
 require 'shaf/generator/migration/create_table'
 require 'shaf/generator/migration/drop_column'
 require 'shaf/generator/migration/empty'

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

@@ -34,9 +34,7 @@ module Shaf
         end
 
         def add_columns_change
-          cols = columns.map do |s|
-            "add_column #{column_def(s, create: false)}"
-          end
+          cols = columns.map { |s| column_def(s, create: false) }
           [
             "alter_table(:#{table_name}) do",
             *cols.map { |col| col.prepend("  ") }, # indent body with 2 spaces

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

@@ -0,0 +1,42 @@
+module Shaf
+  module Generator
+    module Migration
+      class AddIndex < Base
+
+        identifier %w(add index)
+        usage 'generate migration add index TABLE_NAME COLUMN_NAME'
+
+        def validate_args
+          if (table_name || "").empty? || (column || "").empty?
+            raise "Please provide a table and the column to create index on"
+          end
+        end
+
+        def compile_migration_name
+          "add_#{column}_index_to_#{table_name}"
+        end
+
+        def table_name
+          args.first
+        end
+
+        def compile_changes
+          add_change add_index_change
+        end
+
+        def column
+          args[1]
+        end
+
+        def add_index_change
+          col_def =  column_def("#{column}:index", create: false)
+          [
+            "alter_table(:#{table_name}) do",
+            col_def.prepend("  "), # indent body with 2 spaces
+            "end\n"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/shaf/generator/model.rb

@@ -5,10 +5,10 @@ module Shaf
       identifier :model
       usage 'generate model MODEL_NAME [attribute:type] [..]'
 
-      def call
+      def call(options = {})
         create_model
         create_migration
-        create_serializer
+        create_serializer(options)
       end
 
       def model_name
@@ -61,10 +61,10 @@ module Shaf
         Migration::Generator.new(*migration_args).call
       end
 
-      def create_serializer
+      def create_serializer(options)
         serializer_args = %W(serializer #{model_name})
         serializer_args += args[1..-1].map { |arg| arg.split(':').first }
-        Generator::Factory.create(*serializer_args).call
+        Generator::Factory.create(*serializer_args).call(options)
       end
     end
   end

data/lib/shaf/generator/policy.rb

@@ -4,7 +4,7 @@ module Shaf
       identifier :policy
       usage 'generate policy MODEL_NAME [attribute] [..]'
 
-      def call
+      def call(options = {})
         create_policy
       end
 

data/lib/shaf/generator/scaffold.rb

@@ -5,13 +5,13 @@ module Shaf
       identifier :scaffold
       usage 'generate scaffold RESOURCE_NAME [attribute:type] [..]'
 
-      def call
+      def call(options = {})
         if name.empty?
           raise "Please provide a resource name when using the scaffold generator!"
         end
 
-        Generator::Factory.create('model', *args).call
-        Generator::Factory.create('controller', *controller_args).call
+        Generator::Factory.create('model', *args).call(options)
+        Generator::Factory.create('controller', *controller_args).call(options)
       end
 
       def name

data/lib/shaf/generator/serializer.rb

@@ -4,10 +4,10 @@ module Shaf
       identifier :serializer
       usage 'generate serializer MODEL_NAME [attribute] [..]'
 
-      def call
+      def call(options = {})
         create_serializer
-        create_serializer_spec
-        create_policy
+        create_serializer_spec if options[:specs]
+        create_policy(options)
       end
 
       def name
@@ -248,9 +248,9 @@ module Shaf
         }
       end
 
-      def create_policy
+      def create_policy(options)
         policy_args = ["policy", name, *args[1..-1]]
-        Generator::Factory.create(*policy_args).call
+        Generator::Factory.create(*policy_args).call(options)
       end
     end
   end

data/lib/shaf/rake.rb

@@ -0,0 +1,5 @@
+require 'shaf/settings'
+require 'shaf/tasks'
+require 'shaf/rake/db'
+require 'shaf/rake/test'
+

data/lib/shaf/rake/db.rb

@@ -0,0 +1,79 @@
+Shaf::DbTask.new(:version, description: "Prints current schema version") do
+  if migrations.any?
+    version, filename = extract_version_and_filename(last_migration)
+    puts "Schema version: #{version} (#{filename})"
+  else
+    puts "No migrations found"
+  end
+end
+
+Shaf::DbTask.new(:versions, description: "Prints all schema versions") do
+  if migrations.any?
+    migrations.each do |migration|
+      version, filename = extract_version_and_filename(migration)
+      next unless version && filename
+      puts "#{version}: #{filename}"
+    end
+  else
+    puts "No migrations found"
+  end
+end
+
+Shaf::DbTask.new(:migrate, description: "Run migrations", args: [:version]) do |t, args|
+  if args[:version]
+    puts "Migrating to version #{args[:version]}"
+    Sequel::Migrator.run(DB, MIGRATIONS_DIR, target: args[:version].to_i)
+  else
+    puts "Migrating to latest"
+    Sequel::Migrator.run(DB, MIGRATIONS_DIR)
+  end
+end
+
+Shaf::DbTask.new(
+  :rollback,
+  description: "Perform rollback to specified number of steps back or to the previous version",
+  args: [:target]
+) do |t, args|
+
+  args.with_defaults(target: 1)
+  target = -(args[:target].to_i + 1)
+  target = 0 if -target > migrations.size
+  migration = migrations.dig(target, :filename)
+  version, _ = extract_version_and_filename(migration)
+
+  warn_if_rolling_back_more_than = 5
+  if target == 0 || -target > warn_if_rolling_back_more_than
+    puts "This would migrate the Database to version: #{version}. Continue [N/y]?"
+    next unless /\Ay/i =~ STDIN.gets.chomp&.downcase
+  end
+  Sequel::Migrator.run(DB, MIGRATIONS_DIR, target: version.to_i)
+end
+
+Rake::Task["db:migrate"].enhance do
+  Rake::Task["db:version"].invoke
+end
+
+Rake::Task["db:rollback"].enhance do
+  Rake::Task["db:version"].invoke
+end
+
+Shaf::DbTask.new(:reset, description: "Reset the database by deleting all rows in all columns") do
+  version = 0
+  Sequel::Migrator.run(DB, MIGRATIONS_DIR, target: version)
+  Sequel::Migrator.run(DB, MIGRATIONS_DIR)
+end
+
+Shaf::DbTask.new(:seed, description: "Seed the Database") do
+  ENV['RACK_ENV'] ||= 'development'
+  require 'config/bootstrap'
+
+  if File.exist? "db/seeds.rb"
+    require "db/seeds"
+  end
+
+  if Dir.exist? "db/seeds"
+    Dir['db/seeds/**/*.rb'].each do |file|
+      require file.sub(".rb", "")
+    end
+  end
+end

data/lib/shaf/rake/test.rb

@@ -0,0 +1,32 @@
+require 'shaf/tasks'
+
+namespace :test do |ns|
+  Shaf::TestTask.new(:integration) do |t|
+    t.pattern = "spec/integration/**/*_spec.rb"
+  end
+
+  Shaf::TestTask.new(:models) do |t|
+    t.pattern = "spec/models/**/*_spec.rb"
+  end
+
+  Shaf::TestTask.new(:serializers) do |t|
+    t.pattern = "spec/serializers/**/*_spec.rb"
+  end
+
+  Shaf::TestTask.new(:lib) do |t|
+    t.pattern = "spec/lib/**/*_spec.rb"
+  end
+
+  Shaf::TestTask.new(:all) do |t|
+    t.pattern = [
+      "spec/lib/**/*_spec.rb",
+      "spec/models/**/*_spec.rb",
+      "spec/serializers/**/*_spec.rb",
+      "spec/integration/**/*_spec.rb"
+    ]
+  end
+end
+
+desc "Run all tests"
+task test: 'test:all'
+

data/lib/shaf/registrable_factory.rb

@@ -7,6 +7,11 @@ module Shaf
       reg.dup
     end
 
+    def each
+      return all.each unless block_given?
+      all.each { |c| yield c }
+    end
+
     def size
       reg.size
     end
@@ -29,7 +34,7 @@ module Shaf
 
     def usage
       reg.compact.map do |entry|
-        usage = entry.instance_eval { @usage }
+        usage = entry.instance_variable_get(:@usage)
         usage.respond_to?(:call) ? usage.call : usage
       end
     end
@@ -49,7 +54,7 @@ module Shaf
     end
 
     def matching_class?(strings, clazz)
-      identifiers = clazz.instance_eval { @identifiers }
+      identifiers = clazz.instance_variable_get(:@identifiers)
       return false if strings.size < identifiers.size
       identifiers.zip(strings).all? { |pattern, str| matching_identifier? str, pattern }
     end
@@ -62,7 +67,7 @@ module Shaf
     end
 
     def identifier_count(clazz)
-      clazz.instance_eval { @identifiers }&.size || 0
+      clazz.instance_variable_get(:@identifiers)&.size || 0
     end
 
     def init_args(clazz, params)

data/lib/shaf/settings.rb

@@ -18,16 +18,32 @@ module Shaf
       def method_missing(method, *args)
         load unless defined? @settings
 
-        define_singleton_method(method) do
-          @settings.dig(env.to_s, method.to_s)
+        if method.to_s.end_with? "="
+          define_setter(method)
+          public_send(method, args.first)
+        else
+          define_getter(method)
+          public_send(method)
         end
-
-        return public_send(method)
       end
 
       def respond_to_missing?(method, include_private = false)
         return true
       end
+
+      def define_getter(method)
+        define_singleton_method(method) do
+          @settings.dig(env.to_s, method.to_s)
+        end
+      end
+
+      def define_setter(method)
+        define_singleton_method(method) do |arg|
+          key = method[0..-2]
+          @settings[env.to_s] ||= {}
+          @settings[env.to_s][key] = arg
+        end
+      end
     end
   end
 end

data/lib/shaf/tasks.rb

@@ -1,4 +1,7 @@
-require 'shaf/settings'
-require 'shaf/tasks/db'
-require 'shaf/tasks/test'
+require 'shaf/tasks/test_task'
+require 'shaf/tasks/db_task'
+require 'shaf/tasks/api_doc_task'
 
+module Shaf
+  include Tasks
+end