rom-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57acc5483339020a93cd65499e75ca03dc291fd4
-  data.tar.gz: bc3013bffa67f101f3c4fadc45406592736d82ca
+  metadata.gz: 8841ce1317e0b85ca6e9df4bfcdbc30b0a3a545f
+  data.tar.gz: 2f9a18f403fcaf8bda465616937ebfcda0464ec7
 SHA512:
-  metadata.gz: 124e3beef32513ae8c52f06474268e38b8ffc725b8bc72a016aaa7d674d35d4392795fd32122cf33a5fed613f6fb988eeaa822bbe4d5c44731a2d970acfdbd97
-  data.tar.gz: bce26a4fe2fa76fd0e58e57e66f64d5e5a39c90e1e6adce34ed5b8ae45ca4a813d50473df8d59a5ddf45bd9fddb956a5c0d5152def8a641bfcaaecb02a273baa
+  metadata.gz: bac7c987bad0abc06d290b68ebb7078330febd35ff76571cd0e4f240c89c4a494e67dcc519e860b2bae7552f6876691eecb641186b99c08178745da43e881293
+  data.tar.gz: 2d57f131b6515a8176c05fc7574b82aee3e8129385b026c8fa0accf296637427d5ae3e882336867eca2f84d379643e4661afb3d4ff94358e03a85b9a7d946d73

data/.rubocop.yml

@@ -0,0 +1,59 @@
+# FIXME: Lower by refactoring biggest offenders
+Metrics/AbcSize:
+  Max: 26
+
+# FIXME: Lower by refactoring biggest offenders
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# FIXME: No clue how to fix that one line…
+Metrics/LineLength:
+  Exclude:
+    - lib/rom/rails/configuration.rb
+
+# FIXME: Lower by refactoring biggest offenders
+Metrics/MethodLength:
+  Max: 22
+
+# FIXME: Lower by refactoring biggest offenders
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Don’t check temp and Rails-generated files
+AllCops:
+  Exclude:
+    - spec/dummy/Rakefile
+    - spec/dummy/config/**/*
+    - spec/dummy/db/schema.rb
+    - spec/dummy/db/seeds.rb
+    - tmp/**/*
+
+# Documentation checked by Inch CI
+Style/Documentation:
+  Enabled: false
+
+# This is a shim file for those who require 'rom-mongo'
+Style/FileName:
+  Exclude:
+    - lib/rom-rails.rb
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# Model::Validator uses Model::ValidationError for this
+Style/RaiseArgs:
+  Exclude:
+    - lib/rom/model.rb
+
+# Even a single escaped slash can be confusing
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Accept both single and double quotes
+Style/StringLiterals:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.1.4
+2.1

data/.travis.yml

@@ -6,13 +6,13 @@ script: "RAILS_ENV=test rake app:db:schema:load app:spec"
 rvm:
   - 2.0
   - 2.1
+  - 2.2
   - rbx-2
   - jruby
   - ruby-head
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v0.2.0 2014-12-31
+
+### Added
+
+* Generators for relations, mappers and commands (solnic)
+* Support for Spring and reload in development mode (solnic)
+
+### Fixed
+
+* Setup will be skipped when there are missing elements in the registries (solnic)
+
+[Compare v0.1.0...v0.2.0](https://github.com/rom-rb/rom-rails/compare/v0.1.0...v0.2.0)
+
 ## v0.1.0 2014-12-06
 
 ### Added

data/Gemfile

@@ -2,10 +2,14 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rails', '4.1.7'
+gem 'rails', '4.2.0'
 
 gem 'sqlite3', platforms: [:mri, :rbx]
-gem 'jdbc-sqlite3', platforms: :jruby
+
+platforms :jruby do
+  gem 'jdbc-sqlite3'
+  gem 'activerecord-jdbc-adapter'
+end
 
 group :test do
   gem 'rom', github: 'rom-rb/rom', branch: 'master'
@@ -14,4 +18,5 @@ group :test do
   gem 'codeclimate-test-reporter', require: nil
   gem 'database_cleaner'
   gem 'capybara'
+  gem 'generator_spec'
 end

data/README.md

@@ -1,10 +1,3 @@
-[![Gem Version](https://badge.fury.io/rb/rom-rails.svg)][gem]
-[![Build Status](https://travis-ci.org/rom-rb/rom-rails.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-rails.png)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/rom-rb/rom-rails/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-rails/badges/coverage.svg)][codeclimate]
-[![Inline docs](http://inch-ci.org/github/rom-rb/rom-rails.svg?branch=master)][inchpages]
-
 [gem]: https://rubygems.org/gems/rom-rails
 [travis]: https://travis-ci.org/rom-rb/rom-rails
 [gemnasium]: https://gemnasium.com/rom-rb/rom-rails
@@ -14,6 +7,13 @@
 
 # rom-rails
 
+[![Gem Version](https://badge.fury.io/rb/rom-rails.svg)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-rails.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-rails.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-rails/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-rails/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-rails.svg?branch=master)][inchpages]
+
 Rails integration for [Ruby Object Mapper](https://github.com/rom-rb/rom).
 
 ## Installation and setup
@@ -40,22 +40,33 @@ rom's setup object is available via `Rails.application.config.rom.setup`.
 
 ## Relations in controllers
 
-Currently the railtie simply adds `#rom` method to your controllers which returns
-the whole environment. This is **a temporary solution** which is not meant to be final.
+The recommended way of using relations in controllers is to specify which relations
+are needed for particular actions using a DSL provided by the railtie:
+
+``` ruby
+class UsersController < ApplicationController
+  relation 'users.index', only: :index
+  relation 'users.by_name', only: :search, requires: :name
+
+  def index
+    render
+  end
+
+  def search
+    render :index
+  end
+end
+```
 
-Eventually ROM will expose relations to the controller layer (thus view layer too)
-that are already loaded into memory and **there will be no database interactions**
-taking place in those layers. This means that effectively database **query interface
-will not be available in controllers, views, helpers or anywhere outside of the
-relation definitions**.
+By doing this actions will have access to `users` which is also set as a helper
+method making it available in the views.
 
-This means your Rails application will work with arrays of domain objects rather
-than ad-hoc database queries scattered across your entire codebase and there will
-be *a single place* where you define all the relations and object mapping.
+This means **no database interaction will take place in the views or helpers**
+as ROM materializes relations when "injecting" them into controller actions.
 
 ## Status
 
-This project is still in alpha state. For examples of usage please take a look
+This project is still in beta state. For examples of usage please take a look
 at `spec/dummy` app.
 
 Proper documentation will be added once the interface is stable.

data/Rakefile

@@ -1,4 +1,12 @@
 require 'bundler/setup'
+require 'rubocop/rake_task'
+
+task default: %w(app:db:schema:load app:spec rubocop)
 
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
+
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+  task.options << '--rails'
+end

data/lib/generators/rom.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/named_base'
+require 'rom/rails/inflections'
+
+module ROM
+  module Generators
+    class Base < ::Rails::Generators::NamedBase
+      def self.base_name
+        'rom'
+      end
+
+      def self.namespace
+        "rom:#{generator_name}"
+      end
+
+      def self.source_root
+        File.expand_path(
+          "../#{base_name}/#{generator_name}/templates",
+          __FILE__
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+ROM.commands(:<%= class_name.underscore %>) do
+
+  define(:create) do
+    result :one
+  end
+
+  define(:update) do
+    result :one
+  end
+
+  define(:delete) do
+    result :one
+  end
+
+end

data/lib/generators/rom/commands_generator.rb

@@ -0,0 +1,14 @@
+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")
+        )
+      end
+    end
+  end
+end

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

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

data/lib/generators/rom/mapper_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/rom'
+
+module ROM
+  module Generators
+    class MapperGenerator < Base
+      def create_mapper_file
+        template(
+          'mapper.rb.erb',
+          File.join('app', 'mappers', "#{file_name}.rb")
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+ROM.relation(:<%= class_name.underscore %>) do
+  # define your methods here ie:
+  #
+  # def all
+  #   select(:id, :name).order(:id)
+  # end
+  #
+end

data/lib/generators/rom/relation_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/rom'
+
+module ROM
+  module Generators
+    class RelationGenerator < Base
+      def create_relation_file
+        template(
+          'relation.rb.erb',
+          File.join('app', 'relations', "#{file_name}.rb")
+        )
+      end
+    end
+  end
+end

data/lib/rom-rails.rb

@@ -1,8 +1,9 @@
-module Rom
+module ROM
   module Rails
   end
 end
 
-require "rom/rails/version"
-require "rom/rails/railtie"
-require "rom/rails/controller_extension"
+require 'rom'
+require 'rom/rails/version'
+require 'rom/rails/railtie'
+require 'rom/model'

data/lib/rom/model.rb

@@ -0,0 +1,95 @@
+require 'virtus'
+require 'active_model'
+
+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
+      def self.included(base)
+        base.class_eval do
+          include Virtus.model
+          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
+    end
+  end
+end

data/lib/rom/rails/configuration.rb

@@ -0,0 +1,34 @@
+module ROM
+  module Rails
+    class Configuration
+      attr_reader :config, :setup, :env
+
+      def self.build(app)
+        config = app.config.database_configuration[::Rails.env].
+          symbolize_keys.update(root: app.config.root)
+
+        new(ROM::Config.build(config))
+      end
+
+      def initialize(config)
+        @config = config
+      end
+
+      def setup!
+        @setup = ROM.setup(@config.symbolize_keys)
+      end
+
+      def load!
+        Railtie.load_all
+      end
+
+      def finalize!
+        # rescuing fixes the chicken-egg problem where we have a relation
+        # defined but the table doesn't exist yet
+        @env = ROM.finalize.env
+      rescue Registry::ElementNotFoundError => e
+        warn "Skipping ROM setup => #{e.message}"
+      end
+    end
+  end
+end