praxis-mapper 3.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bb0361a7b29be6d0c9d393bf149369d22cfacd1
+  data.tar.gz: f86867db4ccfdd60992aab8cc66cf8959362c7ec
+SHA512:
+  metadata.gz: 13f27e05d0c46b6ed3b906af2fbee4e05425530354ee873eba1097beeacb4df74955b9aa05e064f1ce1165fdda9f72b74beb4c5759454c4493d086c9ffea98d6
+  data.tar.gz: 697c2552d6c1b898df1d77e61e164f844d89361f66a5647ccac2005e745e7ccf7bc7d06acfaf066700d00e19af1f771ed8512f79672e786d0c90fdb9b023dbcb

data/.gitignore

@@ -0,0 +1,26 @@
+*.swp
+*.swo
+
+# YARD
+.yardoc
+
+# Gemfile
+*.gem
+
+# Code coverage
+coverage
+
+# rbenv
+.ruby-version
+
+# Bundler
+.bundle
+
+# Mac OSX files
+.DS_Store
+
+bin
+
+.idea
+
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format=Fuubar
+--backtrace

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.1.2"
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,83 @@
+# praxis-mapper changelog
+
+## next
+
+* Next feature description here 
+
+## 3.1
+
+* Begin migration to Sequel for `Query::Sql`. 
+  * `#_execute` uses it for a database-agnostic adapter for running raw SQL.
+  * `#_multi_get` uses it generate a datbase-agnostic where clause
+* Added accessor generation for `one_to_many` associations in resources.
+* Imported `Model` extensions for FactoryGirl to `praxis-mapper/support/factory_girl`.
+ * This also adds `IdentityMap#persist!` to insert all rows in the identity map into the database.
+* Added `SchemaDumper` and `SchemaLoader` for dumping and loading schema information in `praxis-mapper/support/schema_dumper` and `praxis-mapper/support/schema_loader` respectively.
+* `IdentityMap#all` now accepts non-identity keys as conditions, and will create a secondary index for the key the first time it's queried.
+* Added `Model#identities` to get a hash of identities and values for a record.
+* Auto-generated attribute accessors on `Blueprint` do not load (coerce) the value using the attribute. Ensure values passed in already have the appropriate types. Blueprint attributes will still be wrapped properly, however.
+* Performance and memory use optimizations.
+* `IdentityMap#load` now supports eagerly-loading associated records in a query, and supports the full set of options on the inner query, including 
+* Tracked `:one_to_many` associations now support where clauses. Using `where` clauses when tracking other association types is not supported and will raise an exception.
+
+
+## 3.0
+
+* Moved Blueprint inner attribute creation to finalize!
+* Added :dsl_compiler and :identity as valid options for Blueprint.
+* `Praxis::Mapper::Model`
+  * `Model.context` allows named query parameters to be reused across queries. See documentation for details.
+  * `Model#_query` references original query that loaded the record.
+  * `Model.serialized_fields` returns hash of fields defined with either `json` or `yaml` directives as serialized fields.
+  * Fixed accessors will to raise `KeyError` if the record does not the field (i.e., if it was not loaded from the database), rather than silently returning `nil`.
+* `Praxis::Mapper::Query`:
+  * Multiple `select` and `track` calls within one query are now additive.
+  * `track` option now takes a block that will be applied to the query used to load the tracked records.
+  * `context` directive to apply the named context from the model to the query. See documentation for more.
+* `Praxis::Mapper::IdentityMap`
+  * Removed `:track` option from `#add_records` in favor of using `Model#_query` to determine tracked associations.
+* Added `Praxis::Mapper::Support` with `MemoryQuery` and `MemoryRepository` for use in testing data loading without requiring a database.
+
+
+### Notices
+
+The `Model` accessor changes may break existing applications that (incorrectly) expect unloaded attributes to return `nil`.
+
+
+## 2.1.0
+
+*  Blueprint.validate now only accepts objects of the its type.
+*  Improved handling of Blueprints with circular relations.
+
+
+## 2.0.0
+
+* First pass at reworking model associations.
+  * Split `belongs_to` into `many_to_one` and `array_to_many` associations
+  * Added `one_to_many` and `many_to_array` associations (the inverse of the above associations, aka: has_many)
+  * Added association configuration DSL to replace previous hash-based configuration.
+
+
+## 0.3.1
+
+* Added support for code coverage
+* Added support for 'guard' gem (use 'bundle exec guard')
+* Fixed bug in Praxis::Mapper::Model.undefine\_data\_accessors when method doesn't exist.
+* Safer version checking with Gem::Version class
+* Cleaned up Gemfile
+* Updated 'slop' gem
+
+
+## 0.3.0
+
+* identity map hotfix
+
+
+## 0.2.0
+
+* don't know what happened here, check git log I guess
+
+
+## 0.1.0
+
+* initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    praxis-mapper (3.1.0)
+      activesupport (~> 4)
+      randexp (~> 0)
+      sequel (~> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    debug_inspector (0.0.2)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    fuubar (1.3.3)
+      rspec (>= 2.14.0, < 3.1.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.11)
+    json (1.8.1)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.4.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
+    pry-stack_explorer (0.4.9.1)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rake (0.9.6)
+    randexp (0.1.7)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (2.3.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    ruby-progressbar (1.5.1)
+    sequel (4.13.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    timers (1.1.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  fuubar (~> 1)
+  guard (~> 2)
+  guard-rspec
+  praxis-mapper!
+  pry (~> 0)
+  pry-byebug (~> 1)
+  pry-stack_explorer (~> 0)
+  rake (~> 0)
+  redcarpet (< 3.0)
+  rspec (< 2.99)
+  yard (~> 0.8.7)

data/Guardfile

@@ -0,0 +1,11 @@
+# Config file for Guard
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/praxis-mapper/(.+)\.rb$}) { |m| "spec/praxis-mapper/#{m[1]}_spec.rb" }
+  watch('spec/*.rb')  { 'spec' }
+  watch('lib/praxis-mapper.rb') { 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 RightScale
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Praxis::Mapper
+
+Praxis::Mapper is a library that allows for large amounts of data to be loaded for a tree of associated models,
+while minimizing requests to external services.
+It does multi-stage fetch, with compaction between each stage.
+
+Documentation and examples coming soon.
+
+## Testing
+
+To run unit tests:
+
+    bundle exec rspec
+
+## License
+
+This software is released under the [MIT License](http://www.opensource.org/licenses/MIT). Please see  [LICENSE](LICENSE) for further details.
+
+Copyright (c) 2014 RightScale

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run RSpec code examples with simplecov"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/praxis-mapper/config_hash.rb

@@ -0,0 +1,40 @@
+module Praxis::Mapper
+  class ConfigHash < BasicObject
+
+    attr_reader :hash
+
+    def self.from(hash={},&block)
+      self.new(hash,&block)
+    end
+
+    def initialize(hash={},&block)
+      @hash = hash
+      @block = block
+    end
+
+    def to_hash
+      self.instance_eval(&@block)
+      @hash
+    end
+
+    def method_missing(name, value, *rest, &block)
+      if (existing = @hash[name])
+        if block
+          existing << [value, block]
+        else
+          existing << value
+          rest.each do |v|
+            existing << v
+          end
+        end
+      else
+        if rest.any?
+          @hash[name] = [value] + rest
+        else
+          @hash[name] = value
+        end
+      end
+    end
+
+  end
+end

data/lib/praxis-mapper/connection_manager.rb

@@ -0,0 +1,102 @@
+module Praxis::Mapper
+  class ConnectionManager
+
+    # Configures a data store.
+    def self.setup(config_data={}, &block)
+      config_data.each do |repository_name, data|
+        klass_name = data.delete(:connection_factory)
+        connection_factory_class = Object.const_get(klass_name)
+        repositories[repository_name][:connection_factory] = connection_factory_class.new(data[:connection_opts])
+
+        if (query_klass_name = data.delete(:query))
+          query_klass = Object.const_get(query_klass_name)
+          repositories[repository_name][:query] = query_klass
+        end
+      end
+      if block_given?
+        self.instance_eval(&block)
+      end
+    end
+
+    def self.repository(repository_name, data=nil,&block)
+      return repositories[repository_name] if data.nil? && !block_given?
+
+      if data && data[:query]
+        query_klass = case data[:query]
+        when String
+          query_klass_name = data[:query]
+          Object.const_get(query_klass_name) #FIXME: won't really work consistently
+        when Class
+          data[:query]
+        when Symbol
+          raise "symbol support is not implemented yet"
+        else
+          raise "unknown type for query: #{data[:query].inspect} has type #{data[:query].class}"
+        end
+        repositories[repository_name][:query] = query_klass
+      end
+      
+      if block_given?
+        # TODO: ? complain if data.has_key?(:connection_factory)
+        repositories[repository_name][:connection_factory] = block
+      elsif data
+        klass_name = data.delete(:connection_factory)
+        connection_factory_class = Object.const_get(klass_name) #FIXME: won't really work consistently
+        repositories[repository_name][:connection_factory] = connection_factory_class.new(data[:connection_opts])
+      end
+    end
+
+
+    def self.repositories
+      @repositories ||= Hash.new do |hash,key|
+        hash[key] = {
+          :connection_factory => nil,
+          :query => Praxis::Mapper::Query::Sql
+        }
+      end
+    end
+
+    def repositories
+      self.class.repositories
+    end
+
+    def repository(repository_name)
+      self.repositories[repository_name]
+    end
+
+    def initialize
+      @connections = {}
+    end
+
+    def checkout(name)
+      connection = @connections[name]
+      return connection if connection
+
+      factory = repositories[name][:connection_factory]
+      connection = if factory.kind_of?(Proc)
+        factory.call
+      else
+        factory.checkout
+      end
+
+      @connections[name] = connection
+    end
+
+    def release_one(name)
+      if (connection = @connections.delete(name))
+        return true if repositories[name][:connection_factory].kind_of? Proc
+        repositories[name][:connection_factory].release(connection)
+      end
+    end
+
+    def release(name=nil)
+      if name
+        release_one(name)
+      else
+        names = @connections.keys
+        names.each { |name| release_one(name) }
+      end
+    end
+
+  end
+end

data/lib/praxis-mapper/finalizable.rb

@@ -0,0 +1,38 @@
+module Praxis::Mapper
+  module Finalizable
+
+
+    def self.extended(klass)
+      klass.module_eval do
+        @finalizable = Set.new
+      end
+    end
+
+    def inherited(base)
+      @finalizable << base
+      base.instance_variable_set(:@finalizable, @finalizable)
+      base.instance_variable_set(:@finalized, false)
+    end
+
+    def finalizable
+      @finalizable
+    end
+
+    def finalized?
+      @finalized
+    end
+
+    def _finalize!
+      @finalized = true
+    end
+
+    def finalize! 
+      self.finalizable.reject(&:finalized?).each do |klass|
+        klass._finalize!
+      end
+
+      self.finalize! unless self.finalizable.all?(&:finalized?)
+    end
+
+  end
+end