rom 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 728df93bc1b41195f801808c3849bc5012575181
-  data.tar.gz: be8e7364087eb867e25f2c0347fde4f7eb0dd4db
+  metadata.gz: 18e380f111c5a327bab9a80b4dd82844f82cd485
+  data.tar.gz: 04b327cb735b695647382f47bff9ed8d72fb456b
 SHA512:
-  metadata.gz: b72abeba04fcdfe33de4562a2d81aa1a0b6297dbbee46c9cbe45f13d4e06788c34af039cafb1b741e1a0e7ae6b865bc0f347823edf0735d57b54f57f3e1908ef
-  data.tar.gz: a14e740c4769a9cc6929bee634eaffdfed36d08e58c7c79aa136849387c6e8ed8cfda7bcb9f3e4f4d1ce2ca7e658fb5fc6a6fbaea8b8d2e6fb8f2f535d68cd22
+  metadata.gz: 8ec1a1f1d50794053ebddbf37f88c7ea3f885f55c58e45e76edae8d9c915bfbec3b3419de85bda6298e9a4d25db9cd52b3ff6b4cdd2657f2c09dfbcf7fc9448c
+  data.tar.gz: f31429fd032a6994c27757a98bd2811aa74c16e92ac64d64ded652082dfe92da2f0f6ecf131acfca686222a88c6f1d19b5b0142ecba1dc6a6beee202d1af755d

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## v0.4.0 2014-12-06
+
+### Added
+
+* Command API (solnic)
+* Setup DSL is now available within the `ROM.setup` block (solnic)
+* Support for setting up a logger for an adapter (solnic)
+* New `Adapter#dataset?(name)` which every adapter must implement (solnic)
+
+### Fixed
+
+* method-missing in `Repository` and `Env` kindly calls `super` (solnic)
+
+### Changed
+
+* Abstract `Adapter` defines `:connection` reader so it doesn't have to be
+  defined in adapter descendants (solnic)
+
+[Compare v0.3.1...v0.4.0](https://github.com/rom-rb/rom/compare/v0.3.1...v0.4.0)
+
 ## v0.3.1 2014-11-25
 
 ### Added

data/Gemfile

@@ -8,6 +8,7 @@ group :console do
 end
 
 group :test do
+  gem 'virtus'
   gem 'mutant'
   gem 'mutant-rspec'
   gem 'rubysl-bigdecimal', platforms: :rbx
@@ -18,6 +19,7 @@ end
 
 group :sql do
   gem 'rom-sql', git: 'https://github.com/rom-rb/rom-sql.git', branch: 'master'
+  gem 'sequel'
   gem 'jdbc-sqlite3', platforms: :jruby
   gem 'sqlite3', platforms: [:mri, :rbx]
 end

data/README.md

@@ -24,8 +24,8 @@ a couple of core concepts which makes it different from a typical ORM:
   * It must be **simple** to use the full power of your database
 
 With that in mind ROM ships with adapters that allow you to connect to any
-database and exposes a DSL to define **relations** and **mappers** to simplify
-accessing the data.
+database and exposes a DSL to define **relations**, **mappers** and **commands**
+to simplify accessing and changing the data.
 
 Database support:
 
@@ -35,6 +35,9 @@ Database support:
 See [issues](https://github.com/rom-rb/rom/issues?q=is%3Aopen+is%3Aissue+label%3Aadapter+label%3Afeature)
 for a list of adapters that are planned to be added soon.
 
+ROM can be used with Rails next to ActiveRecord via [rom-rails](https://github.com/rom-rb/rom-rails) railtie.
+Integration with other frameworks is planned.
+
 ## Synopsis
 
 ``` ruby
@@ -48,6 +51,8 @@ setup.sqlite.connection.create_table :users do
   Integer :age
 end
 
+# set up relations
+
 setup.relation(:users) do
   def by_name(name)
     where(name: name)
@@ -58,6 +63,14 @@ setup.relation(:users) do
   end
 end
 
+# set up commands
+
+setup.commands(:users) do
+  define(:create)
+end
+
+# set up mappers
+
 setup.mappers do
   define(:users) do
     model(name: 'User')
@@ -66,12 +79,14 @@ end
 
 rom = setup.finalize
 
+# accessing defined commands
+
+rom.command(:users).try { create(name: "Joe", age: 17) }
+rom.command(:users).try { create(name: "Jane", age: 18) }
+
 # accessing registered relations
 users = rom.relations.users
 
-users.insert(name: "Joe", age: 17)
-users.insert(name: "Jane", age: 18)
-
 puts users.by_name("Jane").adults.to_a.inspect
 # => [{:id=>2, :name=>"Jane", :age=>18}]
 

data/lib/rom.rb

@@ -10,6 +10,8 @@ require 'rom/relation'
 require 'rom/mapper'
 require 'rom/reader'
 
+require 'rom/commands'
+
 require 'rom/adapter'
 require 'rom/repository'
 require 'rom/env'
@@ -18,6 +20,14 @@ require 'rom/boot'
 
 module ROM
   EnvAlreadyFinalizedError = Class.new(StandardError)
+  CommandError = Class.new(StandardError)
+  TupleCountMismatchError = Class.new(CommandError)
+
+  InvalidOptionError = Class.new(StandardError) do
+    def initialize(option, valid_values)
+      super("#{option} should be one of #{valid_values.inspect}")
+    end
+  end
 
   Schema = Class.new(Registry)
   RelationRegistry = Class.new(Registry)
@@ -44,9 +54,9 @@ module ROM
     if block
       boot.instance_exec(&block)
       boot.finalize
+    else
+      boot
     end
-
-    boot
   end
 
 end

data/lib/rom/adapter.rb

@@ -2,13 +2,45 @@ require 'addressable/uri'
 
 module ROM
 
+  # Abstract adapter class
+  #
+  # @api public
   class Adapter
     include Equalizer.new(:connection)
 
     @adapters = []
 
+    # Return connection URI associated with the adapter
+    #
+    # @return [String]
+    #
+    # @api public
     attr_reader :uri
 
+    # Return connection object
+    #
+    # @return [Object] type varies depending on the adapter
+    #
+    # @api public
+    attr_reader :connection
+
+    # Setup an adapter instance with the given connection URI
+    #
+    # @example
+    #
+    #   Adapter = Class.new(ROM::Adapter)
+    #
+    #   adapter = Adapter.new('mysql://localhost/test')
+    #
+    #   adapter.uri.scheme # => 'mysql'
+    #   adapter.uri.host # => 'localhost'
+    #   adapter.uri.path # => '/test'
+    #
+    # @param [String] uri_string
+    #
+    # @return [Adapter]
+    #
+    # @api public
     def self.setup(uri_string)
       uri = Addressable::URI.parse(uri_string)
 
@@ -19,34 +51,108 @@ module ROM
       adapter.new(uri)
     end
 
+    # Register adapter class
+    #
+    # @example
+    #
+    #   Adapter = Class.new(ROM::Adapter) {
+    #     def self.schemes
+    #       [:super_db]
+    #     end
+    #   }
+    #
+    #   ROM::Adapter.register(Adapter)
+    #   ROM::Adapter[:super_db] # => Adapter
+    #
+    # @return [Array] registered adapters
+    #
+    # @api public
     def self.register(adapter)
       @adapters.unshift adapter
     end
 
+    # Return adapter class for the given scheme
+    #
+    # @see Adapter.register
+    #
+    # @return [Class] adapter class
+    #
+    # @api public
     def self.[](scheme)
       @adapters.detect { |adapter| adapter.schemes.include?(scheme.to_sym) }
     end
 
+    # @api private
     def initialize(uri)
       @uri = uri
     end
 
-    def connection
-      raise NotImplementedError, "#{self.class}#connection must be implemented"
-    end
-
+    # Extension hook for adding adapter-specific behavior to a relation class
+    #
+    # @param [Class] klass Relation class generated by ROM
+    #
+    # @return [Class] extended relation class
+    #
+    # @api public
     def extend_relation_class(klass)
       klass
     end
 
+    # Extension hook for adding adapter-specific behavior to a relation instance
+    #
+    # @param [Relation] relation
+    #
+    # @return [Relation] extended relation instance
+    #
+    # @api public
     def extend_relation_instance(relation)
       relation
     end
 
+    # Builds a command
+    #
+    # @param [Symbol] name of the command
+    # @param [Relation] relation used by the command
+    # @param [CommandDSL::Definition] command definition object
+    #
+    # @return [Object] created command instance
+    #
+    # @api public
+    def command(name, relation, definition)
+      type = definition.type || name
+
+      klass =
+        case type
+        when :create then command_namespace.const_get(:Create)
+        when :update then command_namespace.const_get(:Update)
+        when :delete then command_namespace.const_get(:Delete)
+        else
+          raise ArgumentError, "#{type.inspect} is not a supported command type"
+        end
+
+      klass.new(relation, definition.to_h)
+    end
+
+    # Schema inference hook
+    #
+    # Every adapter that supports schema inference should implement this method
+    #
+    # @return [Array] array with datasets and their names
+    #
+    # @api private
     def schema
       []
     end
 
+    # Return namespace with adapter-specific command classes
+    #
+    # @return [Module]
+    #
+    # @api private
+    def command_namespace
+      self.class.const_get(:Commands)
+    end
+
   end
 
 end

data/lib/rom/adapter/memory.rb

@@ -1,64 +1,17 @@
+require 'rom/adapter/memory/storage'
+require 'rom/adapter/memory/dataset'
+require 'rom/adapter/memory/commands'
+
 module ROM
   class Adapter
 
     class Memory < Adapter
-      attr_reader :connection
+      attr_accessor :logger
 
       def self.schemes
         [:memory]
       end
 
-      class Dataset
-        include Charlatan.new(:data)
-
-        def to_ary
-          data
-        end
-        alias_method :to_a, :to_ary
-
-        def each(&block)
-          return to_enum unless block
-          data.each(&block)
-        end
-
-        def restrict(criteria = nil, &block)
-          if criteria
-            find_all { |tuple| criteria.all? { |k, v| tuple[k] == v } }
-          else
-            find_all { |tuple| yield(tuple) }
-          end
-        end
-
-        def project(*names)
-          map { |tuple| tuple.reject { |key,_| names.include?(key) } }
-        end
-
-        def order(*names)
-          sort_by { |tuple| tuple.values_at(*names) }
-        end
-
-        def insert(tuple)
-          data << tuple
-        end
-
-        def header
-          []
-        end
-      end
-
-      class Storage
-        attr_reader :data
-
-        def initialize(*)
-          super
-          @data = {}
-        end
-
-        def [](name)
-          data[name] ||= Dataset.new([])
-        end
-      end
-
       def initialize(*args)
         super
         @connection = Storage.new
@@ -68,6 +21,10 @@ module ROM
         connection[name]
       end
 
+      def dataset?(name)
+        connection.key?(name)
+      end
+
       Adapter.register(self)
     end
 

data/lib/rom/adapter/memory/commands.rb

@@ -0,0 +1,41 @@
+module ROM
+  class Adapter
+    class Memory < Adapter
+
+      module Commands
+
+        class Create < ROM::Commands::Create
+
+          def execute(tuple)
+            attributes = input[tuple]
+            validator.call(attributes)
+            [relation.insert(attributes.to_h).to_a.last]
+          end
+
+        end
+
+        class Update < ROM::Commands::Update
+
+          def execute(params)
+            attributes = input[params]
+            validator.call(attributes)
+            relation.map { |tuple| tuple.update(attributes.to_h) }
+          end
+
+        end
+
+        class Delete < ROM::Commands::Delete
+
+          def execute
+            tuples = target.to_a
+            tuples.each { |tuple| relation.delete(tuple) }
+            tuples
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/rom/adapter/memory/dataset.rb

@@ -0,0 +1,52 @@
+module ROM
+  class Adapter
+    class Memory < Adapter
+
+      class Dataset
+        include Charlatan.new(:data)
+
+        def to_ary
+          data.dup
+        end
+        alias_method :to_a, :to_ary
+
+        def each(&block)
+          return to_enum unless block
+          data.each(&block)
+        end
+
+        def restrict(criteria = nil, &block)
+          if criteria
+            find_all { |tuple| criteria.all? { |k, v| tuple[k] == v } }
+          else
+            find_all { |tuple| yield(tuple) }
+          end
+        end
+
+        def project(*names)
+          map { |tuple| tuple.reject { |key,_| names.include?(key) } }
+        end
+
+        def order(*names)
+          sort_by { |tuple| tuple.values_at(*names) }
+        end
+
+        def insert(tuple)
+          data << tuple
+          self
+        end
+
+        def delete(tuple)
+          data.delete(tuple)
+          self
+        end
+
+        def header
+          []
+        end
+
+      end
+
+    end
+  end
+end