synchronized_models 1.0.0alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '06807cd51b2bde960cc3509e04cb60bd60ef30b1befcb2a64d4a876822e91f9c'
+  data.tar.gz: ba4fd66b6ccb81e868d124ccd87600af1f69144097106be68fdab23b9accc523
+SHA512:
+  metadata.gz: 072032b19d695ed7fb95506ea8f48be0cab4e5d320672a35f047fcfe3876d28f913ad0de1ecec22667b14c5d046d1266ac6c0b50650fe5edc43afc4f368106da
+  data.tar.gz: 19500b7a4ba1d2ea44bb260896476dfa142a23925910096b745d30bcc4bb053219be37218854c32c008cf736340badd620d4b4692893e3f23aca64c413e53a36

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 
+
+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,86 @@
+# SynchronizedModels
+
+Add a model into another model with an external database connection.
+
+[![Build Status](https://travis-ci.org/armando1339/synchronized_models.svg?branch=master)](https://travis-ci.org/armando1339/synchronized_models) [![Coverage Status](https://coveralls.io/repos/github/armando1339/synchronized_models/badge.svg?branch=master)](https://coveralls.io/github/armando1339/synchronized_models?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synchronized_models'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+In the root directory:
+
+```bash
+$ rails generate synchronized_models_initializer
+```
+
+## Usage
+
+Set the values of the external database in the configuration file that was created in config/initializers/synchronized_models.rb by `rails generate synchronized_models_initializer` command.
+
+Example:
+
+```ruby
+class Account < ActiveRecord::Base
+  sync_remote_model model_name: :account
+end
+
+# Then:
+
+Account::RemoteAccount.last
+Account::RemoteAccount.create name: "Some name"
+```
+
+Or:
+
+```ruby
+class Account < ActiveRecord::Base
+  sync_remote_model model_name: :user
+end
+
+# Then:
+
+Account::RemoteUser.last
+Account::RemoteUser.create email: user@example.com, password: 123456
+```
+
+Or:
+
+```ruby
+class Account < ActiveRecord::Base
+  sync_remote_model model_name: :user, table_name: :admins
+end
+
+# Then:
+
+Account::RemoteUser.last
+Account::RemoteUser.create email: user@example.com, password: 123456
+```
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+Make a pull request:
+
+- Clone the repo
+- Create your feature branch
+- Commit your changes
+- Push the branch
+- Create new Pull-Request
+
+Please write tests if necessary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SynchronizedModels'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/generators/synchronized_models_initializer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate initializer Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/synchronized_models_initializer/synchronized_models_initializer_generator.rb

@@ -0,0 +1,7 @@
+class SynchronizedModelsInitializerGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def copy_initializer_file
+    copy_file 'synchronized_models.rb', 'config/initializers/synchronized_models.rb'
+  end
+end

data/lib/generators/synchronized_models_initializer/templates/synchronized_models.rb

@@ -0,0 +1,21 @@
+# => This initializer contains the references
+# to the external database. The assigned values
+# depend on the environment that is running
+# (develpment, staging or production).
+#
+SynchronizedModels.configure do |config|
+  # => optional parameter that 
+  # contain the values 'utf8'
+  # by default
+  #
+  # config.encoding = 'utf8'
+  #
+  # => Required parameters without
+  # default values.
+  #
+  config.adapter    =   ENV['EXTERNAL_DB_ADAPTER']
+  config.host       =   ENV['EXTERNAL_DB_HOST']
+  config.username   =   ENV['EXTERNAL_DB_USERNAME']
+  config.password   =   ENV['EXTERNAL_DB_PASSWORD']
+  config.database   =   ENV['EXTERNAL_DB_NAME']
+end

data/lib/synchronized_models.rb

@@ -0,0 +1,18 @@
+require 'synchronized_models/kernel_synchronizer'
+require 'synchronized_models/configuration'
+
+module SynchronizedModels
+  attr_accessor :configuration
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/synchronized_models/configuration.rb

@@ -0,0 +1,14 @@
+module SynchronizedModels
+  class Configuration
+    attr_accessor :adapter, :encoding, :host, :username, :password, :database
+
+    def initialize
+      @adapter = 'postgresql'
+      @encoding = 'utf8'
+      @host = nil
+      @username = nil
+      @password = nil
+      @database = nil
+    end
+  end
+end

data/lib/synchronized_models/kernel_synchronizer.rb

@@ -0,0 +1,84 @@
+module Kernel
+  #
+  # => This method is executed as a callback to generate an
+  # ActiveRecord::Base constant, within the scope of the same
+  # model where it is called, which will be connected to a
+  # second database.
+  #
+  # Example:
+  #
+  # class Account < ActiveRecord::Base
+  #   sync_remote_model model_name: :account
+  # end
+  #
+  # Then:
+  #
+  # Account::RemoteAccount.last
+  # Account::RemoteAccount.create name: "Some name"
+  #
+  # Or:
+  #
+  # class Account < ActiveRecord::Base
+  #   sync_remote_model model_name: :user
+  # end
+  #
+  # Then:
+  #
+  # Account::RemoteUser.last
+  # Account::RemoteUser.create email: user@example.com, password: 123456
+  #
+  # Or:
+  #
+  # class Account < ActiveRecord::Base
+  #   sync_remote_model model_name: :user, table_name: :admins
+  # end
+  #
+  # Then:
+  #
+  # Account::RemoteUser.last
+  # Account::RemoteUser.create email: user@example.com, password: 123456
+  #
+  def sync_remote_model(*args)
+    configure_sync_constant(*args)
+  end
+
+  private
+
+  # => Create an ActiveRecord::Base constant and add
+  # the remote database configuration that was configured
+  # in config/initializers/synchronized_models.rb
+  #
+  def configure_sync_constant(args={})
+    return false unless ancestors.include? ActiveRecord::Base
+
+    initialize_sync_constant args.fetch(:model_name) do |conts|
+      conts.send :table_name=, select_table_name(args).to_s.tableize
+      conts.establish_connection database_adapter
+    end
+  end
+
+  # => *
+  def initialize_sync_constant(model_name)
+    const_set(
+      "Remote#{model_name.to_s.capitalize}",
+      Class.new(ActiveRecord::Base)
+    )
+
+    yield synchronized_constant(model_name)
+  end
+  
+  # => *
+  def synchronized_constant(model_name)
+    "#{name}::Remote#{model_name.to_s.capitalize}".constantize
+  end
+
+  # => *
+  def select_table_name(args)
+    args.include?(:table_name) ? args.fetch(:table_name) : args.fetch(:model_name)
+  end
+
+  # => *
+  def database_adapter
+    SynchronizedModels.configuration.instance_values
+  end
+end

data/lib/synchronized_models/railtie.rb

@@ -0,0 +1,4 @@
+module SynchronizedModels
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/synchronized_models/version.rb

@@ -0,0 +1,3 @@
+module SynchronizedModels
+  VERSION = '1.0.0alpha'
+end

data/lib/tasks/synchronized_models_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :synchronized_models do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: synchronized_models
+version: !ruby/object:Gem::Version
+  version: 1.0.0alpha
+platform: ruby
+authors:
+- Armando Alejandre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add a model into another model with an external database connection.
+email:
+- armando1339@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/synchronized_models_initializer/USAGE
+- lib/generators/synchronized_models_initializer/synchronized_models_initializer_generator.rb
+- lib/generators/synchronized_models_initializer/templates/synchronized_models.rb
+- lib/synchronized_models.rb
+- lib/synchronized_models/configuration.rb
+- lib/synchronized_models/kernel_synchronizer.rb
+- lib/synchronized_models/railtie.rb
+- lib/synchronized_models/version.rb
+- lib/tasks/synchronized_models_tasks.rake
+homepage: https://github.com/armando1339/synchronized_models
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/armando1339/synchronized_models
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Add a model into another model with an external database connection.
+test_files: []