rom-rails 0.2.1 → 0.3.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d21be75bbb9e3c79f408a7543e948cbbe5a2d48
-  data.tar.gz: 0c7bf6a32c50ceca32d4575f4840725f8b2d2ca6
+  metadata.gz: dca5938e41a98dc3af6fe2aa5d301c13a6984d04
+  data.tar.gz: 372f0581874750544b013ff63048ff60ee69085b
 SHA512:
-  metadata.gz: e16b255e12b8b290652b9d9e19b8dcf585486f65544ee00ec91b537b969d485e035f64b6f8f38ac24c5b913913466dcba4d19221570274144cb2be08f359984e
-  data.tar.gz: f890b82c6a0b8c4b237db7a638ec31731f0e291c2a1ca800d80bc846a333adbcace7fd3b9e99f39af9085932f99dfb986d06a85bba79aa8c7480b278f1aeccae
+  metadata.gz: d0b26883fb509ab4ff4a39294b84d90436bd73c736e653f16ad90b4fb89c8fe6949590ac3f5f1513f0da752291ed96e6d69fb26fd164e47ba22b6a6cff400e94
+  data.tar.gz: d5fe5b5a9c13523bd2d53c5c193402de75e963edce3a79c6a815eff1c8a2f03010af8520cce4f037850a100dcccd96ba7cc1a692d6fd71bbd80fcc531f3c5ba0

data/.rubocop.yml

@@ -8,6 +8,7 @@ Metrics/CyclomaticComplexity:
 
 # FIXME: No clue how to fix that one line…
 Metrics/LineLength:
+  Max: 100
   Exclude:
     - lib/rom/rails/configuration.rb
 
@@ -27,6 +28,23 @@ AllCops:
     - spec/dummy/db/schema.rb
     - spec/dummy/db/seeds.rb
     - tmp/**/*
+    - vendor/**/*
+
+# The enforced style doesn’t match Vim’s defaults
+Style/AlignParameters:
+  Enabled: false
+
+# UTF-8 is perfectly fine in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow using braces for value-returning blocks
+Style/Blocks:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
 
 # Documentation checked by Inch CI
 Style/Documentation:
@@ -41,6 +59,10 @@ Style/FileName:
 Style/GuardClause:
   Enabled: false
 
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
 # Model::Validator uses Model::ValidationError for this
 Style/RaiseArgs:
   Exclude:
@@ -57,3 +79,7 @@ Style/SignalException:
 # Accept both single and double quotes
 Style/StringLiterals:
   Enabled: false
+
+Style/AccessorMethodName:
+  Exclude:
+    - lib/rom/rails/model/params.rb

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v0.3.0 to-be-released
+
+### Added
+
+* `ROM::Model::Form` for modeling and setting up web-forms (solnic + cflipse)
+* Support for timestamps attributes in Form objects (kchien)
+
+
+### Changed
+
+* Improved initialization process which works with AR-style configurations (aflatter)
+* Allow setup using a configuration block from railtie (aflatter)
+
+[Compare v0.2.1...master](https://github.com/rom-rb/rom-rails/compare/v0.2.1...master)
+
 ## v0.2.1 2015-01-07
 
 ### Changed
@@ -8,6 +23,8 @@
 
 * `rom` extension is now mixed into ActionController::Base which addresses #12 (solnic)
 
+[Compare v0.2.1...v0.2.0](https://github.com/rom-rb/rom-rails/compare/v0.2.0...v0.2.1)
+
 ## v0.2.0 2014-12-31
 
 ### Added

data/README.md

@@ -23,6 +23,10 @@ ships with:
 * Mapper generators
 * Command generators
 
+## Issues
+
+Please report any issues in the main [rom-rb/rom](https://github.com/rom-rb/rom/issues) issue tracker.
+
 ## Resources
 
 You can read more about ROM and Rails on the official website:

data/lib/generators/rom/commands/templates/create.rb.erb

@@ -0,0 +1,10 @@
+module <%= model_name %>Commands
+  class Create < ROM::Commands::Create<%= "[:#{adapter}]" %>
+    relation :<%= relation %>
+    register_as :create
+    result :one
+
+    # define a validator to use
+    # validator <%= model_name %>Validator
+  end
+end

data/lib/generators/rom/commands/templates/delete.rb.erb

@@ -0,0 +1,7 @@
+module <%= model_name %>Commands
+  class Delete < ROM::Commands::Delete<%= "[:#{adapter}]" %>
+    relation :<%= relation %>
+    register_as :delete
+    result :one
+  end
+end

data/lib/generators/rom/commands/templates/update.rb.erb

@@ -0,0 +1,10 @@
+module <%= model_name %>Commands
+  class Update < ROM::Commands::Update<%= "[:#{adapter}]" %>
+    relation :<%= relation %>
+    register_as :update
+    result :one
+
+    # define a validator to use
+    # validator <%= model_name %>Validator
+  end
+end

data/lib/generators/rom/commands_generator.rb

@@ -3,11 +3,39 @@ require 'generators/rom'
 module ROM
   module Generators
     class CommandsGenerator < Base
-      def create_commands_file
-        template(
-          'commands.rb.erb',
-          File.join('app', 'commands', "#{file_name}.rb")
-        )
+      class_option :adapter,
+        banner: "--adapter=adapter",
+        desc: "specify an adapter to use", required: true,
+        default: ROM.adapters.keys.first
+
+      def create_create_command
+        template 'create.rb.erb', command_file(:create)
+      end
+
+      def create_update_command
+        template 'update.rb.erb', command_file(:update)
+      end
+
+      def create_delete_command
+        template 'delete.rb.erb', command_file(:delete)
+      end
+
+      private
+
+      def command_file(command)
+        File.join('app', 'commands', file_name, "#{command}.rb")
+      end
+
+      def relation
+        class_name.pluralize.underscore
+      end
+
+      def model_name
+        class_name.singularize
+      end
+
+      def adapter
+        options[:adapter]
       end
     end
   end

data/lib/generators/rom/form/templates/edit_form.rb.erb

@@ -0,0 +1,24 @@
+class Edit<%= model_name %>Form < ROM::Model::Form
+  commands <%= relation %>: :update
+
+  input do
+    set_model_name '<%= model_name %>'
+
+    # define form input attributes
+    # attribute :name, String
+
+    timestamps :updated_at
+  end
+
+  validations do
+    relation :<%= relation %>
+
+    # Add form validations
+    # validates :name, presence: true
+  end
+
+  def commit!
+    <%= relation %>.try { <%= relation %>.update.by_id(id).set(params) }
+  end
+
+end

data/lib/generators/rom/form/templates/new_form.rb.erb

@@ -0,0 +1,24 @@
+class New<%= model_name %>Form < ROM::Model::Form
+  commands <%= relation %>: :create
+
+  input do
+    set_model_name '<%= model_name %>'
+
+    # define form input attributes
+    # attribute :name, String
+
+    timestamps
+  end
+
+  validations do
+    relation :<%= relation %>
+
+    # Add form validations
+    # validates :name, presence: true
+  end
+
+  def commit!
+    <%= relation %>.try { <%= relation %>.create.call(params) }
+  end
+
+end

data/lib/generators/rom/form_generator.rb

@@ -0,0 +1,39 @@
+require 'generators/rom'
+
+module ROM
+  module Generators
+    class FormGenerator < Base
+      class_option :command,
+        banner: "--command=command",
+        desc: "specify command to use", required: true
+
+      def create_command
+        type = edit_or_new
+
+        template "#{type}_form.rb.erb",
+          File.join("app", "forms", "#{type}_#{file_name.singularize}_form.rb")
+      end
+
+      private
+
+      def model_name
+        class_name.singularize.camelcase
+      end
+
+      def relation
+        class_name.pluralize.underscore
+      end
+
+      def edit_or_new
+        case options[:command].downcase
+        when 'edit', 'update'
+          :edit
+        when 'new', 'create'
+          :new
+        else
+          raise "Unknown command"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rom/mapper/templates/mapper.rb.erb

@@ -1,12 +1,10 @@
-ROM.mappers do
-
-  define(:<%= class_name.underscore %>) do
-    # specify model and attributes ie
-    #
-    # model <%= class_name.classify %>
-    #
-    # attribute :name
-    # attribute :email
-  end
-
+class <%= model_name %>Mapper < ROM::Mapper
+  # relation :<%= relation %>
+  #
+  # specify model and attributes ie
+  #
+  # model <%= model_name %>
+  #
+  # attribute :name
+  # attribute :email
 end

data/lib/generators/rom/mapper_generator.rb

@@ -6,9 +6,19 @@ module ROM
       def create_mapper_file
         template(
           'mapper.rb.erb',
-          File.join('app', 'mappers', "#{file_name}.rb")
+          File.join('app', 'mappers', "#{file_name.singularize}_mapper.rb")
         )
       end
+
+      private
+
+      def model_name
+        class_name.singularize
+      end
+
+      def relation
+        class_name.pluralize.underscore
+      end
     end
   end
 end

data/lib/generators/rom/relation/templates/relation.rb.erb

@@ -1,8 +1,9 @@
-ROM.relation(:<%= class_name.underscore %>) do
+class <%= class_name %>Relation < ROM::Relation<%= "[:#{adapter}]" %>
+  dataset :<%= dataset %>
+
   # define your methods here ie:
   #
   # def all
   #   select(:id, :name).order(:id)
   # end
-  #
 end

data/lib/generators/rom/relation_generator.rb

@@ -3,12 +3,27 @@ require 'generators/rom'
 module ROM
   module Generators
     class RelationGenerator < Base
+      class_option :adapter,
+        banner: "--adapter=adapter",
+        desc: "specify an adapter to use", required: true,
+        default: ROM.adapters.keys.first
+
       def create_relation_file
         template(
           'relation.rb.erb',
-          File.join('app', 'relations', "#{file_name}.rb")
+          File.join('app', 'relations', "#{file_name}_relation.rb")
         )
       end
+
+      private
+
+      def dataset
+        class_name.underscore.pluralize
+      end
+
+      def adapter
+        options[:adapter]
+      end
     end
   end
 end

data/lib/rom-rails.rb

@@ -1,8 +1,3 @@
-module ROM
-  module Rails
-  end
-end
-
 require 'rom'
 require 'rom/rails/version'
 require 'rom/rails/railtie'

data/lib/rom/model.rb

@@ -1,97 +1,14 @@
-require 'virtus'
-require 'active_model'
+require 'charlatan'
 
 module ROM
   module Model
     class ValidationError < CommandError
-      attr_reader :params, :messages
-
-      def initialize(params)
-        @params = params
-        @messages = params.errors
-      end
-    end
-
-    # Mixin for validatable and coercible parameters
-    #
-    # @example
-    #
-    #   class UserParams
-    #     include ROM::Model::Params
-    #
-    #     attribute :email, String
-    #     attribute :age, Integer
-    #
-    #     validates :email, :age, presence: true
-    #   end
-    #
-    #   user_params = UserParams.new(email: '', age: '18')
-    #
-    #   user_params.email # => ''
-    #   user_params.age # => 18
-    #
-    #   user_params.valid? # => false
-    #   user_params.errors # => #<ActiveModel::Errors:0x007fd2423fadb0 ...>
-    #
-    # @api public
-    module Params
-      VirtusModel = Virtus.model(strict: true, required: false)
-
-      def self.included(base)
-        base.class_eval do
-          include VirtusModel
-          include ActiveModel::Validations
-          include ActiveModel::Conversion
-        end
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def param_key(name)
-          class_eval <<-RUBY
-            def self.model_name
-              @model_name ||= ActiveModel::Name.new(self, nil, #{name.to_s.inspect})
-            end
-          RUBY
-        end
-
-        def [](input)
-          new(input)
-        end
-      end
-    end
-
-    # Mixin for ROM-compliant validator objects
-    #
-    # @example
-    #
-    #
-    #   class UserParams
-    #     include ROM::Model::Params
-    #
-    #     attribute :name
-    #
-    #     validates :name, presence: true
-    #   end
-    #
-    #   class UserValidator
-    #     include ROM::Model::Validator
-    #   end
-    #
-    #   params = UserParams.new(name: '')
-    #   UserValidator.call(params) # raises ValidationError
-    #
-    # @api public
-    module Validator
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def call(params)
-          raise ValidationError.new(params) unless params.valid?
-        end
-      end
+      include Charlatan.new(:errors)
+      include Equalizer.new(:errors)
     end
   end
 end
+
+require 'rom/rails/model/params'
+require 'rom/rails/model/validator'
+require 'rom/rails/model/form'