RubyGems - hist - Versions diffs - 0.2.0 - Mend

hist 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +30 -0
data/README.md +235 -0
data/Rakefile +32 -0
data/app/assets/config/hist_manifest.js +2 -0
data/app/assets/javascripts/hist/application.js +18 -0
data/app/assets/javascripts/hist/vendor/ace-diff/ace-diff.min.js +2 -0
data/app/assets/javascripts/hist/vendor/bootstrap/bootstrap.min.js +7 -0
data/app/assets/javascripts/hist/vendor/bootstrap/popper.min.js +5 -0
data/app/assets/javascripts/hist/version_diff.js +64 -0
data/app/assets/stylesheets/hist/application.css +16 -0
data/app/assets/stylesheets/hist/default.scss +20 -0
data/app/assets/stylesheets/hist/vendor/ace-diff/ace-diff.min.css +2 -0
data/app/controllers/hist/application_controller.rb +71 -0
data/app/controllers/hist/pendings_controller.rb +21 -0
data/app/controllers/hist/versions_controller.rb +171 -0
data/app/helpers/hist/application_helper.rb +4 -0
data/app/jobs/hist/application_job.rb +4 -0
data/app/mailers/hist/application_mailer.rb +6 -0
data/app/models/hist/application_record.rb +389 -0
data/app/models/hist/config.rb +10 -0
data/app/models/hist/hist_config.rb +124 -0
data/app/models/hist/model.rb +214 -0
data/app/models/hist/pending.rb +53 -0
data/app/models/hist/version.rb +20 -0
data/app/views/hist/_modal_popup.html.erb +29 -0
data/app/views/hist/versions/diff.js.erb +53 -0
data/app/views/layouts/hist/application.html.erb +16 -0
data/app/views/partials/hist/_modal.html.erb +1 -0
data/config/routes.rb +8 -0
data/lib/generators/hist/db_generator.rb +39 -0
data/lib/generators/hist/initializer_generator.rb +15 -0
data/lib/generators/hist/install_generator.rb +29 -0
data/lib/generators/hist/routes_generator.rb +29 -0
data/lib/generators/hist/templates/db/create_hist_pendings.rb.erb +40 -0
data/lib/generators/hist/templates/db/create_hist_versions.rb.erb +40 -0
data/lib/generators/hist/templates/init/hist.rb +9 -0
data/lib/hist.rb +19 -0
data/lib/hist/engine.rb +33 -0
data/lib/hist/versionnumber.rb +3 -0
data/lib/tasks/hist_tasks.rake +4 -0
metadata +156 -0

data/app/views/hist/versions/diff.js.erb ADDED

@@ -0,0 +1,53 @@
+$('#hist-gem-modal').html("<%= j(render partial: 'hist/modal_popup') %>");
+$('#hist-gem-modal').modal('show');
+<% if @aceMode == :json %>
+$(function() {
+    var mode = "ace/mode/json";
+    var left_content = JSON.stringify(<%= @diff_escaped[:left].html_safe %>, null, '\t');
+    var right_content = JSON.stringify(<%= @diff_escaped[:right].html_safe %>, null, '\t');
+    histInstantiateHistory(mode, "<%=@height%>", left_content, right_content);
+});
+<% elsif @aceMode == :yaml %>
+$(function() {
+    var mode = "ace/mode/yaml";
+    var left_content = `<%= YAML.dump(@diff[:left]) %>`;
+    var right_content = `<%= YAML.dump(@diff[:right]) %>`;
+    histInstantiateHistory(mode, "<%=@height%>", left_content, right_content);
+});
+<% elsif @aceMode == :text %>
+$(function() {
+    var mode = "ace/mode/text";
+    var left_content = `<%= @diff[:left].to_s %>`;
+    var right_content = `<%= @diff[:right].to_s %>`;
+    histInstantiateHistory(mode, "<%=@height%>", left_content, right_content);
+// ActiveSupport::JSON.decode(@diff[:version])["doc_files"].first["ocr"].to_s
+// ActiveSupport::JSON.decode(@diff[:current])["doc_files"].first["ocr"].to_s,
+});
+<% elsif @aceMode == :html %>
+$(function() {
+    var mode = "ace/mode/html";
+    var left_content = `<%= @diff[:left].html_safe %>`;
+    var right_content = `<%= @diff[:right].html_safe %>`;
+    histInstantiateHistory(mode, "<%=@height%>", left_content, right_content);
+// ActiveSupport::JSON.decode(@diff[:version])["doc_files"].first["ocr"].to_s
+// ActiveSupport::JSON.decode(@diff[:current])["doc_files"].first["ocr"].to_s,
+});
+<% end %>

data/app/views/layouts/hist/application.html.erb ADDED

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Hist</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag    "hist/application", media: "all" %>
+  <%= javascript_include_tag "hist/application" %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/app/views/partials/hist/_modal.html.erb ADDED

	@@ -0,0 +1 @@
1	+ <div class="modal fade" id="hist-gem-modal" tabindex="-1" role="dialog" data-backdrop="static" aria-hidden="true" data-keyboard="false">Loading...</div>

data/config/routes.rb ADDED

@@ -0,0 +1,8 @@
+Hist::Engine.routes.draw do
+  resources :versions, path: :version, except: :index do
+    collection do
+      get 'diff'
+    end
+  end
+end

data/lib/generators/hist/db_generator.rb ADDED

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+# Based on: https://github.com/ankane/blazer/blob/master/lib/generators/blazer/install_generator.rb
+module Hist
+  class DbGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    # Implement the required interface for Rails::Generators::Migration.
+    def self.next_migration_number(dirname) #:nodoc:
+      next_migration_number = current_migration_number(dirname) + 1
+      if ActiveRecord::Base.timestamped_migrations
+        [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+      else
+        "%.3d" % next_migration_number
+      end
+    end
+    def copy_migration
+      [
+        "create_hist_versions",
+        "create_hist_pendings"
+      ].each do |name|
+        migration_template "db/#{name}.rb.erb", "db/migrate/#{name}.rb", migration_version: migration_version if Dir.glob("db/migrate/*_#{name}.rb").empty?
+      end
+    end
+    def migration_version
+      if ActiveRecord::VERSION::MAJOR >= 5
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/hist/initializer_generator.rb ADDED

@@ -0,0 +1,15 @@
+require 'rails/generators'
+module Hist
+  class InitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Model Generator Hist Engine'
+    def config_initializer_copy
+      copy_file 'init/hist.rb', 'config/initializers/hist.rb' unless File::exists?('config/initializers/hist.rb')
+    end
+  end
+end

data/lib/generators/hist/install_generator.rb ADDED

@@ -0,0 +1,29 @@
+require 'rails/generators'
+module Hist
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc "InstallGenerator Hist Engine"
+    def copy_initializers
+      generate 'hist:initializer'
+    end
+    def generate_migration_scripts
+      generate 'hist:db'
+    end
+    def insert_to_routes
+      generate 'hist:routes'
+    end
+    def bundle_install
+      Bundler.with_clean_env do
+        run 'bundle install'
+      end
+    end
+  end
+end

data/lib/generators/hist/routes_generator.rb ADDED

@@ -0,0 +1,29 @@
+require 'rails/generators'
+module Hist
+  class RoutesGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc """
+  This generator makes the following changes to your application:
+   1. Injects route declarations into your routes.rb
+         """
+    # Add auditsdb to the routes
+    def inject_hist_routes
+      unless IO.read("config/routes.rb").include?('Hist::Engine')
+        marker = 'Rails.application.routes.draw do'
+        insert_into_file "config/routes.rb", :after => marker do
+          %q{
+  # routes for Hist
+  mount Hist::Engine => '/hist'
+}
+        end
+      end
+    end
+  end
+end

data/lib/generators/hist/templates/db/create_hist_pendings.rb.erb ADDED

@@ -0,0 +1,40 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  # The largest text column available in all supported RDBMS is
+  # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
+  # so that MySQL will use `longtext` instead of `text`.  Otherwise,
+  # when serializing very large objects, `text` might not be big enough.
+  TEXT_BYTES = 1_073_741_823
+  def change
+    unless ActiveRecord::Base.connection.table_exists?(:hist_pendings)
+      create_table :hist_pendings do |t|
+        t.string   :model, {:null=>false}
+        t.integer  :obj_id
+        t.string   :whodunnit
+        t.string   :extra
+        t.text     :data, limit: TEXT_BYTES
+        t.datetime :discarded_at
+        # Known issue in MySQL: fractional second precision
+        # -------------------------------------------------
+        #
+        # MySQL timestamp columns do not support fractional seconds unless
+        # defined with "fractional seconds precision". MySQL users should manually
+        # add fractional seconds precision to this migration, specifically, to
+        # the `created_at` column.
+        # (https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html)
+        #
+        # MySQL users should also upgrade to rails 4.2, which is the first
+        # version of ActiveRecord with support for fractional seconds in MySQL.
+        # (https://github.com/rails/rails/pull/14359)
+        #
+        t.datetime :created_at, limit: 6
+      end
+      add_index :hist_pendings, %i(model obj_id)
+      unless index_exists? :hist_pendings, [:discarded_at], name: 'hist_pending_discarded_idy'
+        add_index :hist_pendings, [:discarded_at], name: 'hist_pending_discarded_idy'
+      end
+    end
+  end
+end

data/lib/generators/hist/templates/db/create_hist_versions.rb.erb ADDED

@@ -0,0 +1,40 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  # The largest text column available in all supported RDBMS is
+  # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
+  # so that MySQL will use `longtext` instead of `text`.  Otherwise,
+  # when serializing very large objects, `text` might not be big enough.
+  TEXT_BYTES = 1_073_741_823
+  def change
+    unless ActiveRecord::Base.connection.table_exists?(:hist_versions)
+      create_table :hist_versions do |t|
+        t.string   :model, {:null=>false}
+        t.integer  :obj_id,   null: false
+        t.string   :whodunnit
+        t.string   :extra
+        t.text     :data, limit: TEXT_BYTES
+        t.datetime :discarded_at
+        # Known issue in MySQL: fractional second precision
+        # -------------------------------------------------
+        #
+        # MySQL timestamp columns do not support fractional seconds unless
+        # defined with "fractional seconds precision". MySQL users should manually
+        # add fractional seconds precision to this migration, specifically, to
+        # the `created_at` column.
+        # (https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html)
+        #
+        # MySQL users should also upgrade to rails 4.2, which is the first
+        # version of ActiveRecord with support for fractional seconds in MySQL.
+        # (https://github.com/rails/rails/pull/14359)
+        #
+        t.datetime :created_at, limit: 6
+      end
+      add_index :hist_versions, %i(model obj_id)
+      unless index_exists? :hist_versions, [:discarded_at], name: 'hist_version_discarded_idy'
+        add_index :hist_versions, [:discarded_at], name: 'hist_version_discarded_idy'
+      end
+    end
+  end
+end

data/lib/generators/hist/templates/init/hist.rb ADDED

@@ -0,0 +1,9 @@
+Hist.config do |conf|
+  conf.default_diff_exclude = []
+  conf.default_diff_exclude  << 'created_at'
+  conf.default_diff_exclude  << 'hist_extra'
+  conf.default_diff_exclude  << 'whodunnit'
+  conf.default_diff_exclude  << 'pending_id'
+  conf.default_diff_exclude  << 'ver_id'
+  conf.default_diff_exclude  << 'discarded_at'
+end

data/lib/hist.rb ADDED

@@ -0,0 +1,19 @@
+require "hist/engine"
+module Hist
+  # Your code goes here...
+  def self.model(obj:nil,klass:nil)
+    unless obj.nil?
+      return obj.class.base_class.name
+    end
+    return klass.base_class.name
+  end
+  def self.config
+    @config ||= Hist::Config.instance
+    yield @config if block_given?
+    @config
+  end
+end

data/lib/hist/engine.rb ADDED

@@ -0,0 +1,33 @@
+require 'discard'
+require 'digest'
+module Hist
+  class Engine < ::Rails::Engine
+    isolate_namespace Hist
+    engine_name 'hist'
+    config.autoload_paths += %W(
+    #{config.root}/app/controllers/concerns
+      #{config.root}/app/models/concerns
+      #{config.root}/lib/form_builders
+      #{config.root}/app/workers
+    )
+    initializer "hist" do |app|
+      # use a proc instead of a string
+      app.config.assets.precompile << proc { |path| path =~ /\hist\/.+\.(eot|svg|ttf|woff|png|css|js)\z/ }
+    end
+    # Could we just run "load_tasks" here instead?
+    # This makes our rake tasks visible.
+    rake_tasks do
+      Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..'))) do
+        Dir.glob(File.join('tasks', '*.rake')).each do |railtie|
+          load railtie
+        end
+      end
+    end
+  end
+end

data/lib/hist/versionnumber.rb ADDED

@@ -0,0 +1,3 @@
+module Hist
+  VERSIONNUMBER = '0.2.0'
+end

data/lib/tasks/hist_tasks.rake ADDED

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

metadata ADDED

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: hist
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Steven Anderson
+- Akamai Technologies
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: ace-rails-ap
+  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: jquery-rails
+  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: discard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: Detailed version tracking of an item and its associations in Ruby on
+  Rails. Based on Papertrail but with better association handling.
+email:
+- stevencanderson@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/hist_manifest.js
+- app/assets/javascripts/hist/application.js
+- app/assets/javascripts/hist/vendor/ace-diff/ace-diff.min.js
+- app/assets/javascripts/hist/vendor/bootstrap/bootstrap.min.js
+- app/assets/javascripts/hist/vendor/bootstrap/popper.min.js
+- app/assets/javascripts/hist/version_diff.js
+- app/assets/stylesheets/hist/application.css
+- app/assets/stylesheets/hist/default.scss
+- app/assets/stylesheets/hist/vendor/ace-diff/ace-diff.min.css
+- app/controllers/hist/application_controller.rb
+- app/controllers/hist/pendings_controller.rb
+- app/controllers/hist/versions_controller.rb
+- app/helpers/hist/application_helper.rb
+- app/jobs/hist/application_job.rb
+- app/mailers/hist/application_mailer.rb
+- app/models/hist/application_record.rb
+- app/models/hist/config.rb
+- app/models/hist/hist_config.rb
+- app/models/hist/model.rb
+- app/models/hist/pending.rb
+- app/models/hist/version.rb
+- app/views/hist/_modal_popup.html.erb
+- app/views/hist/versions/diff.js.erb
+- app/views/layouts/hist/application.html.erb
+- app/views/partials/hist/_modal.html.erb
+- config/routes.rb
+- lib/generators/hist/db_generator.rb
+- lib/generators/hist/initializer_generator.rb
+- lib/generators/hist/install_generator.rb
+- lib/generators/hist/routes_generator.rb
+- lib/generators/hist/templates/db/create_hist_pendings.rb.erb
+- lib/generators/hist/templates/db/create_hist_versions.rb.erb
+- lib/generators/hist/templates/init/hist.rb
+- lib/hist.rb
+- lib/hist/engine.rb
+- lib/hist/versionnumber.rb
+- lib/tasks/hist_tasks.rake
+homepage: https://github.com/scande3/hist
+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: []
+rubygems_version: 3.0.1
+signing_key:
+specification_version: 4
+summary: Detailed version tracking of an item and its associations in Ruby on Rails.
+  Based on Papertrail.
+test_files: []