rdux 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfb7f010e3ba48e4a37ff7b1b257b02edb36bd76081dd840b8e04176ed34bc6a
+  data.tar.gz: 4c6b974f39958cf2c312781f2284690e29e2095daa767c4ac6821b2cd788ec49
+SHA512:
+  metadata.gz: 9325ef0b570cefce69e3852d8890671ac112df162dd68d1cc953fe4692def7a9747040cddda41ab1700e7adf918b1cd9f124e9d1c596f1aa57c60bdf49ad6755
+  data.tar.gz: 7ab94f4d3a692b126cfaa940c9f8eaec84bf901c8cdcf50a2b9b1786c80ceb12a17c4235dcafc211607049dc1f39d2480ce1c850f1d05754ecdd4a29434659ba

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 himn1
+
+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,37 @@
+# Rdux
+Short description and motivation.
+
+## Usage
+
+```bash
+$ bin/rails rdux:install:migrations
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rdux'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rdux
+```
+
+## Test
+
+```bash
+$ bin/test
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,29 @@
+# frozen_string_literal: true
+
+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    = 'Rdux'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/models/rdux/action.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rdux
+  class Action < ApplicationRecord
+    def self.table_name_prefix
+      'rdux_'
+    end
+
+    serialize :up_payload, JSON
+    serialize :down_payload, JSON
+
+    validates :name, presence: true
+    validates :up_payload, presence: true
+
+    def up(opts)
+      if opts.any?
+        action_creator.up(up_payload, opts)
+      else
+        action_creator.up(up_payload)
+      end
+    end
+
+    def down
+      action_creator.down(down_payload)
+    end
+
+    private
+
+    def action_creator
+      name.to_s.classify.constantize.new
+    end
+  end
+end

data/db/migrate/20200823045609_create_rdux_actions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateRduxActions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :rdux_actions do |t|
+      t.string :name
+      t.text :up_payload
+      t.text :down_payload
+
+      t.timestamps
+    end
+  end
+end

data/lib/rdux.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rdux/engine'
+
+module Rdux
+  Result = Struct.new(:ok, :down_payload, :resp, :action) do
+    def payload
+      resp || down_payload
+    end
+  end
+
+  module_function
+
+  def dispatch(action_name, payload, opts = {})
+    action = Action.new(name: action_name, up_payload: payload)
+    res = action.up(opts)
+    action.down_payload = res.down_payload
+    res.down_payload = action.down_payload
+    action.save! if res.ok
+    res.action = action
+    res
+  end
+end

data/lib/rdux/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rdux
+  class Engine < ::Rails::Engine
+    isolate_namespace Rdux
+  end
+end

data/lib/rdux/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rdux
+  VERSION = '0.1.0'
+end

data/lib/tasks/rdux_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :rdux do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rdux
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zbigniew Humeniuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-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: 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: |
+  Write apps that are easy to test.
+  Rdux gives you a possibility to centralize your app's state modification logic (DB changes).
+  It does it via introducing a new architectural layer - actions.
+  Rdux enables powerful capabilities like undo/redo.
+  It makes it easy to trace when, where, why, and how your application's state changed.
+email:
+- hello@artofcode.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/rdux/action.rb
+- db/migrate/20200823045609_create_rdux_actions.rb
+- lib/rdux.rb
+- lib/rdux/engine.rb
+- lib/rdux/version.rb
+- lib/tasks/rdux_tasks.rake
+homepage: https://artofcode.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Rdux adds a new layer to Rails apps - actions.
+test_files: []