rom-rails 0.1.0 → 0.2.0

data/lib/rom/rails/controller_extension.rb

@@ -1,13 +1,46 @@
 module ROM
   module Rails
+    RelationParamsMissingError = Class.new(StandardError)
 
     module ControllerExtension
+      def self.included(klass)
+        klass.extend(ClassExtensions)
+      end
 
       def rom
         ::Rails.application.config.rom.env
       end
 
-    end
+      module ClassExtensions
+        def relation(path, options)
+          root, method = path.split('.').map(&:to_sym)
+
+          name = options.fetch(:as) { root }
+          requires = Array(options.fetch(:requires) { [] })
+
+          before_filter(options.except(:as, :requires)) do
+            args = params.values_at(*requires)
 
+            if requires.any? && args.none?
+              raise RelationParamsMissingError
+            else
+              relation =
+                if args.any?
+                  rom.read(root).send(method, *args)
+                else
+                  rom.read(root).send(method)
+                end
+
+              instance_variable_set("@#{name}", relation.to_a)
+            end
+          end
+
+          unless respond_to?(name)
+            attr_reader name
+            helper_method name
+          end
+        end
+      end
+    end
   end
 end

data/lib/rom/rails/inflections.rb

@@ -0,0 +1,5 @@
+require 'active_support/inflections'
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym 'ROM'
+end

data/lib/rom/rails/railtie.rb

@@ -1,78 +1,52 @@
-module ROM
-  module Rails
-
-    class Configuration
-      attr_reader :config, :setup, :env
-
-      def self.build(app)
-        root = app.config.root
-        db_config = app.config.database_configuration[::Rails.env].symbolize_keys
-
-        config = rewrite_config(root, db_config)
-
-        new(config)
-      end
-
-      def self.rewrite_config(root, config)
-        adapter = config[:adapter]
-        database = config[:database]
-        password = config[:password]
-        username = config[:username]
-        hostname = config.fetch(:hostname) { 'localhost' }
+require 'rails'
 
-        adapter = "sqlite" if adapter == "sqlite3"
+require 'rom/rails/inflections'
+require 'rom/rails/configuration'
+require 'rom/rails/controller_extension'
 
-        path =
-          if adapter == "sqlite"
-            "#{root}/#{database}"
-          else
-            db_path = [hostname, database].join('/')
+if defined?(Spring)
+  Spring.after_fork { ROM::Rails::Railtie.disconnect }
+end
 
-            if username && password
-              [[username, password].join(':'), db_path].join('@')
-            else
-              db_path
-            end
-          end
+module ROM
+  module Rails
+    class Railtie < ::Rails::Railtie
+      def self.disconnect
+        return unless ROM.env
 
-        { default: "#{adapter}://#{path}" }
+        ROM.env.repositories.each_value do |repository|
+          repository.adapter.disconnect
+        end
       end
 
-      def initialize(config)
-        @config = config
-        @setup = ROM.setup(@config.symbolize_keys)
+      def self.load_all
+        %w(relations mappers commands).each do |type|
+          load_files(type, ::Rails.root)
+        end
       end
 
-      def finalize
-        @env = setup.finalize
+      def self.load_files(type, root)
+        Dir[root.join("app/#{type}/**/*.rb").to_s].each do |path|
+          load(path)
+        end
       end
-    end
-
-    class Railtie < ::Rails::Railtie
 
       initializer "rom.configure" do |app|
-        config.rom = ROM::Rails::Configuration.build(app)
+        config.rom = Configuration.build(app)
       end
 
-      initializer "rom.load_schema" do |app|
+      initializer "rom.load_schema" do |_app|
         require schema_file if schema_file.exist?
       end
 
-      initializer "rom.load_relations" do |app|
-        relation_files.each { |file| require file }
-      end
-
-      initializer "rom.load_mappers" do |app|
-        mapper_files.each { |file| require file }
-      end
-
-      initializer "rom.load_commands" do |app|
-        command_files.each { |file| require file }
-      end
-
-      config.after_initialize do |app|
-        app.config.rom.finalize
-        ApplicationController.send(:include, ControllerExtension)
+      initializer "rom:prepare" do |app|
+        config.to_prepare do |_config|
+          Railtie.disconnect
+          app.config.rom.setup!
+          app.config.rom.load!
+          app.config.rom.finalize!
+          ApplicationController.send(:include, ControllerExtension)
+        end
       end
 
       private
@@ -81,23 +55,9 @@ module ROM
         root.join('db/rom/schema.rb')
       end
 
-      def relation_files
-        Dir[root.join('app/relations/**/*.rb').to_s]
-      end
-
-      def mapper_files
-        Dir[root.join('app/mappers/**/*.rb').to_s]
-      end
-
-      def command_files
-        Dir[root.join('app/commands/**/*.rb').to_s]
-      end
-
       def root
         ::Rails.root
       end
-
     end
-
   end
 end

data/lib/rom/rails/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Rails
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

data/rom-rails.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = ROM::Rails::VERSION.dup
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
-  spec.summary       = %q{Integrate Ruby Object Mapper with Rails}
-  spec.homepage      = ""
+  spec.summary       = 'Integrate Ruby Object Mapper with Rails'
+  spec.homepage      = "http://rom-rb.org"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -17,9 +17,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'rom', '~> 0.4', '>= 0.4.0'
+  spec.add_runtime_dependency 'rom', '~> 0.5', '>= 0.5.0'
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
   spec.add_runtime_dependency 'railties', ['>= 3.0', '< 5.0']
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop", "~> 0.28.0"
 end

data/spec/dummy/app/commands/users.rb

@@ -1,9 +1,7 @@
-setup = Rails.application.config.rom.setup
-
-setup.commands(:users) do
-
+ROM.commands(:users) do
   define(:create) do
+    input UserParams
+    validator UserValidator
     result :one
   end
-
 end

data/spec/dummy/app/controllers/users_controller.rb

@@ -1,7 +1,20 @@
 class UsersController < ApplicationController
+  rescue_from ROM::Rails::RelationParamsMissingError do
+    head :bad_request
+  end
+
+  relation 'users.index', only: :index
+  relation 'users.by_name', only: :search, requires: :name
 
   def index
-    render locals: { users: rom.read(:users).to_a }
+    render
   end
 
+  def search
+    render :index
+  end
+
+  def ping
+    head :ok
+  end
 end

data/spec/dummy/app/mappers/users.rb

@@ -1,6 +1,4 @@
-setup = Rails.application.config.rom.setup
-
-setup.mappers do
+ROM.mappers do
   define(:users) do
     model User
 

data/spec/dummy/app/params/user_params.rb

@@ -0,0 +1,7 @@
+class UserParams
+  include ROM::Model::Params
+
+  attribute :name, String
+
+  validates :name, presence: true
+end

data/spec/dummy/app/relations/users.rb

@@ -1,9 +1,9 @@
-setup = Rails.application.config.rom.setup
-
-setup.relation(:users) do
+ROM.relation(:users) do
+  def index
+    order(:name)
+  end
 
   def by_name(name)
-    where(name: name)
+    index.where(name: name)
   end
-
 end

data/spec/dummy/app/validators/user_validator.rb

@@ -0,0 +1,3 @@
+class UserValidator
+  include ROM::Model::Validator
+end

data/spec/dummy/config/boot.rb

@@ -1,4 +1,4 @@
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/environments/development.rb

@@ -15,5 +15,4 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
-
 end

data/spec/dummy/config/environments/production.rb

@@ -22,7 +22,6 @@ Dummy::Application.configure do
   # Disable Rails's static asset server (Apache or nginx will already do this).
   config.serve_static_assets = false
 
-
   # Specifies the header that your server uses for sending files.
   # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
@@ -45,7 +44,6 @@ Dummy::Application.configure do
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = "http://assets.example.com"
 
-
   # Ignore bad email addresses and do not raise email delivery errors.
   # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false

data/spec/dummy/config/environments/test.rb

@@ -12,10 +12,6 @@ Dummy::Application.configure do
   # preloads Rails for running tests, you may have to set it to true.
   config.eager_load = false
 
-  # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
-  config.static_cache_control = "public, max-age=3600"
-
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false

data/spec/dummy/config/routes.rb

@@ -1,3 +1,5 @@
 Dummy::Application.routes.draw do
   get '/users' => 'users#index'
+  get '/users/search' => 'users#search'
+  get '/users/ping' => 'users#ping'
 end

data/spec/dummy/db/schema.rb

@@ -11,10 +11,17 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20141110205016) do
+ActiveRecord::Schema.define(version: 20141220203134) do
+  create_table "cars", force: true do |_t|
+  end
+
+  create_table "planes", force: true do |_t|
+  end
+
+  create_table "stuffs", force: true do |_t|
+  end
 
   create_table "users", force: true do |t|
     t.string "name"
   end
-
 end

data/spec/dummy/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe UsersController, type: :controller do
+  describe 'injected relations' do
+    it 'exposes relation without required params' do
+      get :index
+
+      expect(controller.users).to eql(rom.read(:users).index.to_a)
+    end
+
+    it 'exposes relation with required params' do
+      get :search, name: 'Jane'
+
+      expect(controller.users).to eql(rom.read(:users).by_name('Jane').to_a)
+    end
+
+    it 'halts processing when required params are missing' do
+      get :search
+
+      expect(response.status).to be(400)
+    end
+
+    it 'skips injecting relation when :only option is used' do
+      get :ping
+
+      expect(controller.users).to be(nil)
+    end
+  end
+end

data/spec/dummy/spec/features/users_spec.rb

@@ -2,12 +2,21 @@ require 'spec_helper'
 
 feature 'Users' do
   background do
-    Rails.application.config.rom.env.relations.users.insert(name: 'Piotr')
+    rom.relations.users.insert(name: 'Jane')
+    rom.relations.users.insert(name: 'Joe')
   end
 
   scenario 'I see user list on index page' do
     visit '/users'
 
-    expect(page).to have_content('Piotr')
+    expect(page).to have_content('Jane')
+    expect(page).to have_content('Joe')
+  end
+
+  scenario 'I can search users' do
+    visit '/users/search?name=Jane'
+
+    expect(page).to have_content('Jane')
+    expect(page).to_not have_content('Joe')
   end
 end

data/spec/dummy/spec/integration/logger_spec.rb

@@ -4,8 +4,9 @@ describe 'ROM logger' do
   let(:rom) { Rails.application.config.rom.env }
 
   it 'sets up rails logger for all repositories' do
-    pending 'this will be re-enabled once we have feature detection on adapters ' +
-      'and in case of missing rails-log-subscriber support we will set logger to Rails.logger'
+    pending 'this will be re-enabled once we have feature detection on ' \
+      'adapters and in case of missing rails-log-subscriber support we ' \
+      'will set logger to Rails.logger'
     rom.repositories.each_value do |repository|
       expect(repository.logger).to be(Rails.logger)
     end

data/spec/dummy/spec/integration/user_commands_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe 'User commands' do
+  subject(:users) { rom.command(:users) }
+
+  describe 'create' do
+    it 'inserts user with valid params' do
+      result = users.try { create(name: 'Jade') }
+
+      expect(result.value).to eql(id: 1, name: 'Jade')
+    end
+
+    it 'returns error if params are not valid' do
+      result = users.try { create(name: '') }
+
+      expect(result.value).to be(nil)
+      expect(result.error).to be_instance_of(ROM::Model::ValidationError)
+      expect(result.error.messages[:name]).to include("can't be blank")
+    end
+  end
+end