duty_free 1.0.0

data/lib/duty_free/util.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module DutyFree
+  module Util
+    # def self._parse(arel)
+    #   arel = arel.arel if arel.is_a?(ActiveRecord::Relation)
+    #   sels = arel.ast.cores.select { |x| x.is_a?(Arel::Nodes::SelectCore) }
+    #   # source (joinsource) / projections (6) is the most interesting here
+    #   sels.each_with_index do |sel, idx|
+    #     puts "#{idx} ============="
+    #     # Columns:
+    #     sel.projections.map do |x|
+    #       case
+    #       when x.is_a?(Arel::Nodes::SqlLiteral)
+    #         puts x.to_s
+    #       else
+    #         puts "#{x.class} #{x.name}"
+    #       end
+    #     end
+    #   end
+    #   nil
+    # end
+
+    def self._recurse_arel(piece, prefix = '')
+      names = []
+      # Our JOINs mashup of nested arrays and hashes
+      if piece.is_a?(Array)
+        names += piece.inject([]) { |s, v| s + _recurse_arel(v, prefix) }
+      elsif piece.is_a?(Hash)
+        names += piece.inject([]) do |s, v|
+          new_prefix = "#{prefix}#{v.first}_"
+          s << new_prefix
+          s + _recurse_arel(v.last, new_prefix)
+        end
+
+      # ActiveRecord AREL objects
+      elsif piece.is_a?(Arel::Nodes::JoinSource)
+        # The left side is the "FROM" table
+        # names += _recurse_arel(piece.left)
+        # The right side is an array of all JOINs
+        names += piece.right.inject([]) { |s, v| s + _recurse_arel(v) }
+      elsif piece.is_a?(Arel::Nodes::Join) # INNER or OUTER JOIN
+        # The left side is the "JOIN" table
+        names += _recurse_arel(piece.left)
+        # (The right side of these is the "ON" clause)
+      elsif piece.is_a?(Arel::Table) # Table
+        names << piece.name
+      elsif piece.is_a?(Arel::Nodes::TableAlias) # Alias
+        # Can get the real table name from:  self._recurse_arel(piece.left)
+        names << piece.right.to_s # This is simply a string; the alias name itself
+      end
+      names
+    end
+
+    def self._prefix_join(prefixes, separator = nil)
+      prefixes.reject(&:blank?).join(separator || '.')
+    end
+
+    def self._clean_name(name, import_columns_as)
+      return name if name.is_a?(Symbol)
+
+      # Expand aliases
+      (import_columns_as || []).each do |k, v|
+        if (k[-1] == ' ' && name.start_with?(k)) || name == k
+          name.replace(v + name[k.length..-1])
+          break
+        end
+      end
+      name
+    end
+  end
+end

data/lib/duty_free/version_number.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module DutyFree
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY = 0
+
+    # PRE is nil unless it's a pre-release (beta, RC, etc.)
+    PRE = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.').freeze
+
+    def self.to_s
+      STRING
+    end
+  end
+end

data/lib/generators/duty_free/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Generates (but does not run) a migration to add a versions table.

data/lib/generators/duty_free/install_generator.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module DutyFree
+  # Installs DutyFree in a rails app.
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    # Class names of MySQL adapters.
+    # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
+    # - `Mysql2Adapter` - Used by `mysql2` gem.
+    MYSQL_ADAPTERS = [
+      'ActiveRecord::ConnectionAdapters::MysqlAdapter',
+      'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
+    ].freeze
+
+    source_root File.expand_path('templates', __dir__)
+    class_option(
+      :with_changes,
+      type: :boolean,
+      default: false,
+      desc: 'Store changeset (diff) with each version'
+    )
+
+    desc 'Generates (but does not run) a migration to add a versions table.' \
+         '  Also generates an initializer file for configuring DutyFree'
+
+    def create_migration_file
+      add_duty_free_migration('create_versions')
+      add_duty_free_migration('add_object_changes_to_versions') if options.with_changes?
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+  protected
+
+    def add_duty_free_migration(template)
+      migration_dir = File.expand_path('db/migrate')
+      if self.class.migration_exists?(migration_dir, template)
+        ::Kernel.warn "Migration already exists: #{template}"
+      else
+        migration_template(
+          "#{template}.rb.erb",
+          "db/migrate/#{template}.rb",
+          item_type_options: item_type_options,
+          migration_version: migration_version,
+          versions_table_options: versions_table_options
+        )
+      end
+    end
+
+  private
+
+    # MySQL 5.6 utf8mb4 limit is 191 chars for keys used in indexes.
+    def item_type_options
+      opt = { null: false }
+      opt[:limit] = 191 if mysql?
+      ", #{opt}"
+    end
+
+    def migration_version
+      return unless (major = ActiveRecord::VERSION::MAJOR) >= 5
+
+      "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+
+    def mysql?
+      MYSQL_ADAPTERS.include?(ActiveRecord::Base.connection.class.name)
+    end
+
+    # Even modern versions of MySQL still use `latin1` as the default character
+    # encoding. Many users are not aware of this, and run into trouble when they
+    # try to use DutyFree in apps that otherwise tend to use UTF-8. Postgres, by
+    # comparison, uses UTF-8 except in the unusual case where the OS is configured
+    # with a custom locale.
+    #
+    # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
+    # - http://www.postgresql.org/docs/9.4/static/multibyte.html
+    #
+    # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
+    # to be fixed later by introducing a new charset, `utf8mb4`.
+    #
+    # - https://mathiasbynens.be/notes/mysql-utf8mb4
+    # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
+    #
+    def versions_table_options
+      if mysql?
+        ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/generators/duty_free/templates/add_object_changes_to_versions.rb.erb

@@ -0,0 +1,12 @@
+# This migration adds the optional `object_changes` column, in which DutyFree
+# will store the `changes` diff for each update event. See the readme for
+# details.
+class AddObjectChangesToVersions < ActiveRecord::Migration<%= migration_version %>
+  # The largest text column available in all supported RDBMS.
+  # See `create_versions.rb` for details.
+  TEXT_BYTES = 1_073_741_823
+
+  def change
+    add_column :versions, :object_changes, :text, limit: TEXT_BYTES
+  end
+end

data/lib/generators/duty_free/templates/create_versions.rb.erb

@@ -0,0 +1,36 @@
+# This migration creates the `versions` table, the only schema PT requires.
+# All other migrations PT provides are optional.
+class CreateVersions < 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
+    create_table :versions<%= versions_table_options %> do |t|
+      t.string   :item_type<%= item_type_options %>
+      t.integer  :item_id,   null: false
+      t.string   :event,     null: false
+      t.string   :whodunnit
+      t.text     :object, limit: TEXT_BYTES
+
+      # 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
+    end
+    add_index :versions, %i(item_type item_id)
+  end
+end

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: duty_free
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lorin Thwaits
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |
+  An ActiveRecord extension that simplifies importing and exporting of data
+  stored in one or more models.  Source and destination can be CSV, XLS,
+  XLSX, ODT, HTML tables, or simple Ruby arrays.
+email: lorint@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/duty_free.rb
+- lib/duty_free/column.rb
+- lib/duty_free/config.rb
+- lib/duty_free/extensions.rb
+- lib/duty_free/frameworks/cucumber.rb
+- lib/duty_free/frameworks/rails.rb
+- lib/duty_free/frameworks/rails/controller.rb
+- lib/duty_free/frameworks/rails/engine.rb
+- lib/duty_free/frameworks/rspec.rb
+- lib/duty_free/serializers/json.rb
+- lib/duty_free/serializers/yaml.rb
+- lib/duty_free/suggest_template.rb
+- lib/duty_free/util.rb
+- lib/duty_free/version_number.rb
+- lib/generators/duty_free/USAGE
+- lib/generators/duty_free/install_generator.rb
+- lib/generators/duty_free/templates/add_object_changes_to_versions.rb.erb
+- lib/generators/duty_free/templates/create_versions.rb.erb
+homepage: https://github.com/lorint/duty_free
+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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Import and Export Data
+test_files: []