active_pstore 0.4.10 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8e9351722c286fca7c3d7479e1b0bf92cc76550
-  data.tar.gz: 5ab5c558ffaae1f4e6bf6fd9b395dde4d1b8c95d
+  metadata.gz: 8ddecb64b2c35e955f66716f4d39988c48d4e7bc
+  data.tar.gz: 951efa2d736bbef69a07826bd741f4d2f9742299
 SHA512:
-  metadata.gz: 6652d3af6d54d323985c5fd6b65e07c93f9d88d3833e47318e515bba39cb82bd8f7d0a9ad32256e42482ddcce2ef159a10e61004f3b179b49bd5520e87a48f39
-  data.tar.gz: 4c34716b4c75ef5aa4e598f23660d21c56826701c8ad106a0483cef097cc83d14efee74f756b33c0938cbdca1d7b78b1644e74306e7c4ac63e1e4a3c8be8f98a
+  metadata.gz: 00ac7cace452785391cb7cc434041f0924521a6af5761de04da193bdefbd3779d72b0d50a415e37b9a3702e96abb6f7d38de828373f5350f771148a3da2aade6
+  data.tar.gz: 2db3e10910cd48e568f6abeb37f7bb2b426b3a5355cc7c4f2de8d49f5007b5aaf7dfa8b1c353b1a88d8f2caa110df7512fbcccc8399603de83a85c2701db3c1e

data/README.md

@@ -107,6 +107,37 @@ Artist.where(birth_date: Date.new(1948, 12, 3)..Date.new(1956, 12, 6))
 
 see [spec codes](https://github.com/koic/active_pstore/tree/master/spec) for more information.
 
+## Integration with Rails
+
+### Generate config file
+
+Execute these lines to your Rails application directory:
+
+```
+bundle exec rails g active_pstore:config
+```
+
+And then create config/active_pstore.yml.
+
+### Generate model file
+
+Execute these lines to your Rails application directory:
+
+```
+bundle exec rails g active_pstore:model artist name associated_act instrument birth_date
+```
+
+And then create app/models/artist.rb
+
+```ruby
+class Artist < ActivePStore::Base
+  attr_accessor :name
+  attr_accessor :associated_act
+  attr_accessor :instrument
+  attr_accessor :birth_date
+end
+```
+
 ## REQUIREMENTS
 
 * [Active Model](https://github.com/rails/rails/tree/master/activemodel)

data/lib/active_pstore/railtie.rb

@@ -1,109 +1,47 @@
-#require "mongoid/railties/document"
-require 'rails'
-require 'rails/active_pstore'
-
 module Rails
   module ActivePStore
-
-    # Hooks ActivePStore into Rails 3 and higher.
-    #
-    # @since 2.0.0
     class Railtie < Rails::Railtie
-
-      # Mapping of rescued exceptions to HTTP responses
-      #
-      # @example
-      #   railtie.rescue_responses
-      #
-      # @ return [Hash] rescued responses
-      #
-      # @since 2.4.3
       def self.rescue_responses
         {
-          'ActivePStore::Errors::RecordNotFound' => :not_found
-#          "Mongoid::Errors::Validations" => 422
+          'ActivePStore::RecordNotFound' => :not_found
         }
       end
 
-      config.app_generators.orm :active_pstore, migration: false
-
       if config.action_dispatch.rescue_responses
         config.action_dispatch.rescue_responses.merge!(rescue_responses)
       end
 
-#      rake_tasks do
-#        load "mongoid/railties/database.rake"
-#      end
-
-      # Exposes Mongoid's configuration to the Rails application configuration.
-      #
-      # @example Set up configuration in the Rails app.
-      #   module MyApplication
-      #     class Application < Rails::Application
-      #       config.mongoid.logger = Logger.new($stdout, :warn)
-      #       config.mongoid.persist_in_safe_mode = true
-      #     end
-      #   end
-      #
-      # @since 2.0.0
-#      config.mongoid = ::Mongoid::Config
-
-      # Initialize Mongoid. This will look for a mongoid.yml in the config
-      # directory and configure mongoid appropriately.
-      #
-      # @since 2.0.0
-=begin
-      initializer "mongoid.load-config" do
-        config_file = Rails.root.join("config", "mongoid.yml")
-        if config_file.file?
-          begin
-            ::Mongoid.load!(config_file)
-          rescue ::Mongoid::Errors::NoClientsConfig => e
-            handle_configuration_error(e)
-          rescue ::Mongoid::Errors::NoDefaultSession => e
-            handle_configuration_error(e)
-          rescue ::Mongoid::Errors::NoSessionDatabase => e
-            handle_configuration_error(e)
-          rescue ::Mongoid::Errors::NoSessionHosts => e
-            handle_configuration_error(e)
-          end
+      # Loads and returns the entire raw configuration of database from
+      # values stored in `config/active_pstore.yml`.
+      def database_configuration
+        yaml = Pathname.new('config/active_pstore.yml')
+
+        config = if yaml && yaml.exist?
+          require 'yaml'
+          require 'erb'
+          YAML.load(ERB.new(yaml.read).result) || {}
+        else
+          raise 'Could not load database configuration. No such file - config/active_pstore.yml'
         end
+
+        config
+      rescue Psych::SyntaxError => e
+        raise "YAML syntax error occurred while parsing config/active_pstore.yml. " \
+              "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+              "Error: #{e.message}"
+      rescue => e
+        raise e, "Cannot load `Rails::ActivePStore::Railtie.database_configuration`:\n#{e.message}", e.backtrace
       end
-=end
 
-      # Set the proper error types for Rails. DocumentNotFound errors should be
-      # 404s and not 500s, validation errors are 422s.
-      #
-      # @since 2.0.0
-#      config.after_initialize do
-#        unless config.action_dispatch.rescue_responses
-#          ActionDispatch::ShowExceptions.rescue_responses.update(Railtie.rescue_responses)
-#        end
-#      end
+      initializer 'active_pstore.initialize_database' do
+        config_file = Rails.root.join('config', 'active_pstore.yml')
 
-      # Due to all models not getting loaded and messing up inheritance queries
-      # and indexing, we need to preload the models in order to address this.
-      #
-      # This will happen for every request in development, once in other
-      # environments.
-      #
-      # @since 2.0.0
-#      initializer "mongoid.preload-models" do |app|
-#        config.to_prepare do
-#          ::Rails::Mongoid.preload_models(app)
-#        end
-#      end
+        if config_file.file?
+          database = database_configuration.fetch(ENV['RAILS_ENV'] || 'development').fetch('database')
 
-      # Rails runs all initializers first before getting into any generator
-      # code, so we have no way in the intitializer to know if we are
-      # generating a mongoid.yml. So instead of failing, we catch all the
-      # errors and print them out.
-      #
-      # @since 3.0.0
-#      def handle_configuration_error(e)
-#        puts "There is a configuration error with the current mongoid.yml."
-#        puts e.message
-#      end
+          ::ActivePStore::Base.establish_connection(database: database)
+        end
+      end
     end
   end
 end

data/lib/active_pstore/version.rb

@@ -1,3 +1,3 @@
 module ActivePStore
-  VERSION = '0.4.10'
+  VERSION = '0.5.0'
 end

data/lib/active_pstore.rb

@@ -16,3 +16,7 @@ require 'active_pstore/query_methods'
 require 'active_pstore/querying'
 require 'active_pstore/base'
 require 'active_pstore/errors'
+
+if defined?(Rails)
+  require 'active_pstore/railtie'
+end

data/lib/rails/generators/active_pstore/config/config_generator.rb

@@ -1,22 +1,14 @@
-require 'rails/generators/active_pstore_generator'
-
-module Active_Pstore
+module ActivePstore
   module Generators
     class ConfigGenerator < Rails::Generators::Base
-      desc "Creates a Active_Pstore configuration file at config/active_pstore.yml"
-
-      argument :database_name, type: :string, optional: true
+      desc 'Creates a Active PStore configuration file at config/active_pstore.yml'
 
       def self.source_root
-        @_active_pstore_source_root ||= File.expand_path("../templates", __FILE__)
-      end
-
-      def app_name
-        Rails::Application.subclasses.first.parent.to_s.underscore
+        File.expand_path('../templates', __FILE__)
       end
 
       def create_config_file
-        template 'active_pstore.yml', File.join('config', "active_pstore.yml")
+        template 'active_pstore.yml', File.join('config', 'active_pstore.yml')
       end
     end
   end

data/lib/rails/generators/active_pstore/config/templates/active_pstore.yml

@@ -1,135 +1,20 @@
-development:
-  # Configure available database clients. (required)
-  clients:
-    # Defines the default client. (required)
-    default:
-      # Defines the name of the default database that Mongoid can connect to.
-      # (required).
-      database: <%= database_name || app_name %>_development
-      # Provides the hosts the default client can connect to. Must be an array
-      # of host:port pairs. (required)
-      hosts:
-        - localhost:27017
-      options:
-        # Change the default write concern. (default = { w: 1 })
-        # write:
-        #   w: 1
-
-        # Change the default read preference. Valid options for mode are: :secondary,
-        # :secondary_preferred, :primary, :primary_preferred, :nearest
-        # (default: primary)
-        # read:
-        #   mode: :secondary_preferred
-
-        # The name of the user for authentication.
-        # user: 'user'
-
-        # The password of the user for authentication.
-        # password: 'password'
-
-        # The user's database roles.
-        # roles:
-        #   - 'dbOwner'
-
-        # Change the default authentication mechanism. Valid options are: :scram,
-        # :mongodb_cr, :mongodb_x509, and :plain. (default on 3.0 is :scram, default
-        # on 2.4 and 2.6 is :plain)
-        # auth_mech: :scram
-
-        # The database or source to authenticate the user against. (default: admin)
-        # auth_source: admin
-
-        # Force a the driver cluster to behave in a certain manner instead of auto-
-        # discovering. Can be one of: :direct, :replica_set, :sharded. Set to :direct
-        # when connecting to hidden members of a replica set.
-        # connect: :direct
-
-        # Changes the default time in seconds the server monitors refresh their status
-        # via ismaster commands. (default: 10)
-        # heartbeat_frequency: 10
-
-        # The time in seconds for selecting servers for a near read preference. (default: 5)
-        # local_threshold: 5
-
-        # The timeout in seconds for selecting a server for an operation. (default: 30)
-        # server_selection_timeout: 30
-
-        # The maximum number of connections in the connection pool. (default: 5)
-        # max_pool_size: 5
-
-        # The minimum number of connections in the connection pool. (default: 1)
-        # min_pool_size: 1
-
-        # The time to wait, in seconds, in the connection pool for a connection
-        # to be checked in before timing out. (default: 5)
-        # wait_queue_timeout: 5
-
-        # The time to wait to establish a connection before timing out, in seconds.
-        # (default: 5)
-        # connect_timeout: 5
-
-        # The timeout to wait to execute operations on a socket before raising an error.
-        # (default: 5)
-        # socket_timeout: 5
+#
+#   Ensure the Active PStore gem is defined in your Gemfile
+#   gem 'active_pstore'
+#
+default: &default
 
-        # The name of the replica set to connect to. Servers provided as seeds that do
-        # not belong to this replica set will be ignored.
-        # replica_set: name
-
-        # Whether to connect to the servers via ssl. (default: false)
-        # ssl: true
-
-        # The certificate file used to identify the connection against MongoDB.
-        # ssl_cert: /path/to/my.cert
-
-        # The private keyfile used to identify the connection against MongoDB.
-        # Note that even if the key is stored in the same file as the certificate,
-        # both need to be explicitly specified.
-        # ssl_key: /path/to/my.key
-
-        # A passphrase for the private key.
-        # ssl_key_pass_phrase: password
-
-        # Whether or not to do peer certification validation. (default: false)
-        # ssl_verify: true
-
-        # The file containing a set of concatenated certification authority certifications
-        # used to validate certs passed from the other end of the connection.
-        # ssl_ca_cert: /path/to/ca.cert
-
-
-  # Configure Mongoid specific options. (optional)
-  options:
-    # Includes the root model name in json serialization. (default: false)
-    # include_root_in_json: false
-
-    # Include the _type field in serialization. (default: false)
-    # include_type_for_serialization: false
-
-    # Preload all models in development, needed when models use
-    # inheritance. (default: false)
-    # preload_models: false
-
-    # Raise an error when performing a #find and the document is not found.
-    # (default: true)
-    # raise_not_found_error: true
-
-    # Raise an error when defining a scope with the same name as an
-    # existing method. (default: false)
-    # scope_overwrite_exception: false
-
-    # Use Active Support's time zone in conversions. (default: true)
-    # use_activesupport_time_zone: true
+development:
+  <<: *default
+  database: db/active_pstore_development.yml
 
-    # Ensure all times are UTC in the app side. (default: false)
-    # use_utc: false
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
 test:
-  clients:
-    default:
-      database: <%= database_name || app_name %>_test
-      hosts:
-        - localhost:27017
-      options:
-        read:
-          mode: primary
-        max_pool_size: 1
+  <<: *default
+  database: db/active_pstore_test.yml
+
+production:
+  <<: *default
+  database: db/active_pstore_production.yml

data/lib/rails/generators/active_pstore/model/model_generator.rb

@@ -1,18 +1,16 @@
-require 'rails/generators/active_pstore_generator'
-
-module Active_Pstore
+module ActivePstore
   module Generators
-    class ModelGenerator < Base
-      desc 'Creates a ActivePStore model'
-      argument :attributes, type: :array, default: [], banner: 'attribute_name attribute_name'
+    class ModelGenerator < Rails::Generators::NamedBase
+      desc 'Creates a Active PStore model'
+      argument :attributes, type: :array, default: [], banner: 'attribute_name_1 attribute_name_2'
 
-      check_class_collision
+      def self.source_root
+        File.expand_path('../templates', __FILE__)
+      end
 
       def create_model_file
         template 'model.rb.tt', File.join('app/models', class_path, "#{file_name}.rb")
       end
-
-      hook_for :test_framework
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_pstore
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.5.0
 platform: ruby
 authors:
 - Koichi ITO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -72,11 +72,6 @@ files:
 - lib/active_pstore/dynamic_matchers.rb
 - lib/active_pstore/errors.rb
 - lib/active_pstore/finder_methods.rb
-- lib/active_pstore/generators/active_pstore/config/config_generator.rb
-- lib/active_pstore/generators/active_pstore/config/template/active_pstore.yml
-- lib/active_pstore/generators/active_pstore/model/model_generator.rb
-- lib/active_pstore/generators/active_pstore/model/templates/model.rb.tt
-- lib/active_pstore/generators/active_pstore_generator.rb
 - lib/active_pstore/inheritance.rb
 - lib/active_pstore/integration.rb
 - lib/active_pstore/model_schema.rb
@@ -85,12 +80,10 @@ files:
 - lib/active_pstore/querying.rb
 - lib/active_pstore/railtie.rb
 - lib/active_pstore/version.rb
-- lib/rails/active_pstore.rb
 - lib/rails/generators/active_pstore/config/config_generator.rb
 - lib/rails/generators/active_pstore/config/templates/active_pstore.yml
 - lib/rails/generators/active_pstore/model/model_generator.rb
 - lib/rails/generators/active_pstore/model/templates/model.rb.tt
-- lib/rails/generators/active_pstore_generator.rb
 homepage: http://github.com/koic/active_pstore
 licenses:
 - MIT

data/lib/active_pstore/generators/active_pstore/config/config_generator.rb

@@ -1,23 +0,0 @@
-require 'rails/generators/active_pstore_generator'
-
-module Active_Pstore
-  module Generators
-    class ConfigGenerator < Rails::Generators::Base
-      desc 'Creates a Active_Pstore configuration file at config/active_pstore.yml'
-
-#      argument :database_name, type: :string, optional: true
-
-      def self.source_root
-        @_active_pstore_source_root ||= File.expand_path('../templates', __FILE__)
-      end
-
-      def app_name
-        Rails::Application.subclasses.first.parent.to_s.underscore
-      end
-
-      def create_config_file
-        template 'active_pstore.yml', File.join('config', 'active_pstore.yml')
-      end
-    end
-  end
-end

data/lib/active_pstore/generators/active_pstore/config/template/active_pstore.yml

@@ -1,20 +0,0 @@
-#
-#   Ensure the Active PStore gem is defined in your Gemfile
-#   gem 'active_pstore'
-#
-default: &default
-
-development:
-  <<: *default
-  database: db/active_pstore_development.yml
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  <<: *default
-  database: db/active_pstore_test.yml
-
-production:
-  <<: *default
-  database: db/active_pstore_production.yml

data/lib/active_pstore/generators/active_pstore/model/model_generator.rb

@@ -1,24 +0,0 @@
-require 'rails/generators/active_pstore_generator'
-
-module ActivePStore
-  module Generators
-#    class ModelGenerator < Base
-    class ModelGenerator < Rails::Generators::Base
-
-      desc "Creates a ActivePStore model"
-      argument :attributes, type: :array, default: [], banner: "attribute attribute"
-
-      check_class_collision
-
-#      class_option :timestamps, type: :boolean
-#      class_option :parent,     type: :string, desc: "The parent class for the generated model"
-#      class_option :collection, type: :string, desc: "The collection for storing model's documents"
-
-      def create_model_file
-        template 'model.rb.tt', File.join('app/models', class_path, "#{file_name}.rb")
-      end
-
-      hook_for :test_framework
-    end
-  end
-end

data/lib/active_pstore/generators/active_pstore/model/templates/model.rb.tt

@@ -1,7 +0,0 @@
-<% module_namespacing do -%>
-class <%= class_name %> < ActivePStore::Base
-<% attributes.reject {|attr| attr.reference? }.each do |attribute| -%>
-  attr_reader :<%= attribute.name %>
-<% end -%>
-end
-<% end -%>

data/lib/active_pstore/generators/active_pstore_generator.rb

@@ -1,28 +0,0 @@
-require "rails/generators/named_base"
-require "rails/generators/active_model"
-
-module ActivePStore
-  module Generators
-    class Base < ::Rails::Generators::NamedBase
-
-      def self.source_root
-        @_active_pstore_source_root ||=
-          File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
-      end
-    end
-  end
-end
-
-=begin
-module Rails
-  module Generators
-    class GeneratedAttribute
-      def type_class
-        return "Time" if type == :datetime
-        return "String" if type == :text
-        return "Mongoid::Boolean" if type == :boolean
-        type.to_s.camelcase
-      end
-    end
-  end
-=end

data/lib/rails/active_pstore.rb

@@ -1,55 +0,0 @@
-module Rails
-  module ActivePStore
-    extend self
-
-    # Use the application configuration to get every model and require it, so
-    # that indexing and inheritance work in both development and production
-    # with the same results.
-    #
-    # @example Load all the application models.
-    #   Rails::Mongoid.load_models(app)
-    #
-    # @param [ Application ] app The rails application.
-    def load_models(app)
-      app.config.paths['app/models'].expanded.each do |path|
-        preload = ::ActivePStore.preload_models
-        if preload.resizable?
-          files = preload.map {|model| "#{path}/#{model.underscore}.rb" }
-        else
-          files = Dir.glob("#{path}/**/*.rb")
-        end
-
-        files.sort.each do |file|
-          load_model(file.gsub("#{path}/" , "").gsub(".rb", ""))
-        end
-      end
-    end
-
-    # Conditionally calls `Rails::Mongoid.load_models(app)` if the
-    # `::Mongoid.preload_models` is `true`.
-    #
-    # @param [ Application ] app The rails application.
-    def preload_models(app)
-      load_models(app) if ::ActivePStore.preload_models
-    end
-
-    private
-
-    # I don't want to mock out kernel for unit testing purposes, so added this
-    # method as a convenience.
-    #
-    # @example Load the model.
-    #   Mongoid.load_model("/mongoid/behaviour")
-    #
-    # @param [ String ] file The base filename.
-    #
-    # @since 2.0.0.rc.3
-    def load_model(file)
-      begin
-        require_dependency(file)
-      rescue Exception => e
-        Logger.new($stdout).warn(e.message)
-      end
-    end
-  end
-end

data/lib/rails/generators/active_pstore_generator.rb

@@ -1,28 +0,0 @@
-require 'rails/generators/named_base'
-require 'rails/generators/active_model'
-
-module Active_Pstore
-  module Generators
-    class Base < ::Rails::Generators::NamedBase
-      def self.source_root
-        @_active_pstore_source_root ||=
-          File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
-      end
-    end
-  end
-end
-
-=begin
-module Rails
-  module Generators
-    class GeneratedAttribute
-      def type_class
-        return "Time" if type == :datetime
-        return "String" if type == :text
-        return "Mongoid::Boolean" if type == :boolean
-        type.to_s.camelcase
-      end
-    end
-  end
-end
-=end