distributable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12c155b9647754f6a436ba5ce5a74c28b4062513
+  data.tar.gz: e1c8881c0786a9e363b5e9056a607e378613def5
+SHA512:
+  metadata.gz: 33fbf2d244ed7ff582880a430778c08f405ed92e07bde809e849193a279281aeaea09f1bc0d798b7d1f1cb2fd3533be6797749f11718f959630131c49021d408
+  data.tar.gz: 4335887220ce9d2f5fb576dc6f7867642f9cd308eda0866e646eb6a869fb88169d1c0ffa03e42fe40ded9ac6379b874d1f79cdab1ef65185ccd42ee2343ed9fd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Chris Liaw
+
+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,66 @@
+# What is Distributable?
+
+Distributable gem is to assist in creating the framework for the data to be distributed across multiple nodes.
+
+What it does at this version is to:
+* Add 'identifier' field to the table structure. This field shall be populated with SecureRandom UUID during record creation and duplication is checked before commit. If you have already has the field defined then the field shall be used.
+* Add change_logs table to keep track of which distributable table has changed (added/edited/deleted). These changed record is the target to be synced across to other database later.
+
+### Motivation
+This comes when a distributed issue tracking system is being formulated to match the benefit of distributed issue tracker such as Git. Git has numerous value to developer in mobile, such as myself that could allow the source code to be distributed even without a central server. If the Git does not strictly need a central server, we are opted that issue tracker, which tied to the source of the code changed that is translated into the Git commit, should also be distributed to ensure the pace of the issue resolution is in tandem with the Git check ins. 
+
+### Why not just used database that has distributed feature?
+There are some RDBMS or NoSQL database do already have high grade distribution feature included such as PostgreSQL, Hadoop, CouchBase etc. However not all database has it. This mainly is to provide consistant distributable feature to the system that is being build without depending on database selection. 
+
+Also using this approach allow more fine grind control on data such that in a database, not all data would be suitable to be synced. One example would be local use access table. Local use access is meant to control which user has what access when the user is connecting to the system. That has no meaning or even harmful to other node as the access rights of a particular user in my node (Imagine you can push your changes to my laptop and your access rights does not mean the same with other team member who is a junior developer that consistantly breaks things).
+
+
+## Usage
+This gem is designed and tested under Rails environment. 
+
+For a particular table that you wish to add to the distributable scope (here the sample table is DistributedRecord):
+```ruby
+class DistributedRecord < AppicationRecord
+	distributable
+end
+```
+and you are done!
+
+Upon record creation, a random SecureRandom UUID shall be inserted into the field identifier and changes would be recorded into the change_logs table created via command
+```bash
+$ rake distributable:setup
+```
+
+You can check if a model is marked as distributable by checking
+```ruby
+@model.distributed?
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'distributable'
+```
+
+And then execute:
+```bash
+$ bundle
+$ rake distributable:setup
+```
+The rake command only required to execute once per project.
+
+Or install it yourself as:
+```bash
+$ gem install distributable
+```
+If you install yourself, after included into the Gemfile, you still required to execute
+```bash
+$ rake distributable:setup
+```
+
+## Contributing
+You can contribute by forking the project. Just drop me a message so that I know who's
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Distributable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/distributable_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/distributable .js
+//= link_directory ../stylesheets/distributable .css

data/app/assets/javascripts/distributable/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/distributable/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/distributable/application_controller.rb

@@ -0,0 +1,5 @@
+module Distributable
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/distributable/application_helper.rb

@@ -0,0 +1,4 @@
+module Distributable
+  module ApplicationHelper
+  end
+end

data/app/jobs/distributable/application_job.rb

@@ -0,0 +1,4 @@
+module Distributable
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/distributable/application_mailer.rb

@@ -0,0 +1,6 @@
+module Distributable
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/distributable/application_record.rb

@@ -0,0 +1,5 @@
+module Distributable
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/distributable/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Distributable</title>
+  <%= stylesheet_link_tag    "distributable/application", media: "all" %>
+  <%= javascript_include_tag "distributable/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Distributable::Engine.routes.draw do
+end

data/lib/distributable.rb

@@ -0,0 +1,105 @@
+require "distributable/engine"
+require 'securerandom'
+
+module Distributable
+	module DistributedNode
+		extend ActiveSupport::Concern
+
+		included do
+		end
+
+		module ClassMethods
+			# 
+			# this install the logic and kick started the operation
+			# 
+			def distributable(opts = {})
+				options = {
+					dist_key: :identifier,
+					skipped: %w(created_at updated_at created_by updated_by id),
+					change_log_table: "change_logs",
+					sync_log_table: "sync_ogs",
+					log: Logger.new(STDOUT)
+				}
+
+				options.merge!(opts)
+
+				self.primary_key = options[:dist_key].to_sym
+
+				before_create :generate_identifier
+
+				after_create :log_new
+				after_update :log_update
+				after_destroy :log_destroy
+
+				#validates options[:dist_key].to_sym, uniqueness: true
+				@@options = options
+			end
+
+			def options
+				@@options
+			end
+
+		end
+
+		# instance methods
+		def distributed?
+			true
+		end
+
+		def generate_identifier
+			if self.has_attribute?(:identifier)
+				while(true)
+					self.identifier = SecureRandom.uuid
+					cnt = eval("#{self.class.name}.where([\"identifier = ?\",'#{self.identifier}']).count")
+					break if cnt == 0
+				end
+			else
+				STDERR.puts "Identifier field does not exist in schema"
+			end		
+		end
+
+
+
+		def log_new
+			opts = self.class.options
+			if ActiveRecord::Base.connection.table_exists?(opts[:change_log_table].to_s)
+				log = eval("#{opts[:change_log_table].to_s.classify}.new")	
+				log.table_name = self.class.table_name
+				log.key = self.send opts[:dist_key]
+				log.operation = 1
+				log.save
+			end
+		end
+
+		def log_update
+			opts = self.class.options
+			if ActiveRecord::Base.connection.table_exists?(opts[:change_log_table].to_s)
+				if self.changed.length > 0
+					changed = self.changed.delete_if { |c| opts[:skipped].include?(c) }
+					if changed.length > 0
+
+						log = eval("#{opts[:change_log_table].to_s.classify}.new")	
+						log.table_name = self.class.table_name
+						log.key = self.send opts[:dist_key]
+						log.changed_fields = changed.to_yaml
+						log.operation = 2
+						log.save
+
+					end
+				end
+			end
+		end
+
+		def log_destroy
+			opts = self.class.options
+			if ActiveRecord::Base.connection.table_exists?(opts[:change_log_table].to_s)
+				log = eval("#{opts[:change_log_table].to_s.classify}.new")	
+				log.table_name = self.class.table_name
+				log.key = self.send opts[:dist_key]
+				log.operation = 3
+				log.save
+			end
+		end
+
+	end
+end

data/lib/distributable/engine.rb

@@ -0,0 +1,11 @@
+module Distributable
+  class Engine < ::Rails::Engine
+    isolate_namespace Distributable
+
+		config.to_prepare do
+			# include into ApplicationController
+			#ActionController::Base.send :include, Canopus::Concerns::Controllers::Authenticator
+			ActiveRecord::Base.send :include, Distributable::DistributedNode
+		end		
+  end
+end

data/lib/distributable/version.rb

@@ -0,0 +1,3 @@
+module Distributable
+  VERSION = '0.1.0'
+end

data/lib/tasks/distributable_tasks.rake

@@ -0,0 +1,28 @@
+# desc "Explaining what the task does"
+# task :distributable do
+#   # Task goes here
+# end
+
+namespace "distributable" do
+	desc "Setup the environment for distributable to work"
+	task :setup do
+		#out = Thread.new do
+			# create change log table
+			STDOUT.puts `rails g model change_log table_name:string key:string operation:integer changed_fields:text`
+			STDOUT.flush
+			STDOUT.puts "Distributable based model generated..."
+			STDOUT.flush
+			STDOUT.puts `rails db:migrate`
+			STDOUT.flush
+		#end
+
+		#i = Thread.new do
+		#	$stdin.each_line do |l|
+		#		STDOUT.puts l
+		#	end
+		#end
+
+		# createh sync log table
+		#sl = `rails g model sync_log node_id:string user_id:string`
+	end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: distributable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Liaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: ''
+email:
+- chrisliaw@antrapol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/distributable_manifest.js
+- app/assets/javascripts/distributable/application.js
+- app/assets/stylesheets/distributable/application.css
+- app/controllers/distributable/application_controller.rb
+- app/helpers/distributable/application_helper.rb
+- app/jobs/distributable/application_job.rb
+- app/mailers/distributable/application_mailer.rb
+- app/models/distributable/application_record.rb
+- app/views/layouts/distributable/application.html.erb
+- config/routes.rb
+- lib/distributable.rb
+- lib/distributable/engine.rb
+- lib/distributable/version.rb
+- lib/tasks/distributable_tasks.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []