dropkiq 0.1.8 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca530f5f1cb0665300e76bd129eb0bb1e71038bd
-  data.tar.gz: d4c5bf9dc8f5f5f15ee8962ba9cfae2d0f499b79
+  metadata.gz: 79323cdebbbd66a06c273745adeec22144d81d84
+  data.tar.gz: 38fe7ff01b60bddac23b649811d22232fc18d902
 SHA512:
-  metadata.gz: 9e4d82928aacd87fbd0734ffb3bdff7506e369c101019ce2a02435545f28d53d4c7b132b4db53fe3ba36419b7fa632e1f16731c49e266411709c2c44da2783b6
-  data.tar.gz: 6884dfd454274a2ca16ade992c7351aa24da39193a805270ae4f9dbd5c594983fa658ce254da43bcc8e4cfbdd6ad7d693450907324a98d33ec3c42342c0fcb25
+  metadata.gz: 7a3ea5a984d07fb2ea97ecb330f7f21a07f303c7a03ff015ea862fea5f378a544d3b75fb03a9a42a25c7beacb2a189210214ef813901ba92dcefd8718424ba41
+  data.tar.gz: 5e804c999f7f5505eda283bbe3b83a4f4af4f58e12644383bab045ea29e210e95a7b174f2297a3ead7ae2c9ef656a3d6a316a2fb0387feaf955bc60f41319793

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropkiq (0.1.8)
+    dropkiq (0.1.11)
       activerecord (>= 4.2)
       liquid (~> 4.0)
 

data/README.md

@@ -30,7 +30,7 @@ Or install it yourself as:
 
 This Gem makes several assumptions about your Ruby on Rails application:
 
-* Drop classes are expected to have the same name as the corresponding Rails model. For example, if you have an ActiveRecord model with name of `Person`, the drop class is expected to be called `PersonDrop`
+* Drop classes are expected to have the same name as the corresponding Rails model. For example, if you have an ActiveRecord model with name of `Person`, the drop class is expected to be called `PersonDrop` (Ruby on Rails applications using the legacy `liquid_methods` method with [PR #568](https://github.com/Shopify/liquid/pull/568) are also supported.)
 * Drop class methods are expected to return the same data type as the corresponding Rails-model getter methods for relationships and columns.
 * This Gem has not been tested with Rails models that have non-default primary key (other than `id`).
 
@@ -44,7 +44,7 @@ bundle exec rake dropkiq:schema
 
 You should now have a `db/dropkiq_schema.yaml` file. This file describes all tables associated to Drop classes in your application, along with all methods avaialble to the Drop class. It is important that you **DO** allow this file to be checked in to version control so that you can maintain your Dropkiq schema over time as you add/remove/modify your Drop classes.
 
-Notice that `type` has NOT been set on all methods. The Dropkiq Gem is only able to infer the method type for methods that correspond to a column or relationship on the ActiveRecord model. Please take a moment to manually add `type` values for all methods that were not able to be inferred. Notice that if you run `bundle exec rake dropkiq:schema` again, your changes are saved!
+Notice that `type` has NOT been set on all methods. The Dropkiq Gem is only able to infer the method type for methods that correspond to a column or relationship on the ActiveRecord model. Please take a moment to manually add `type` values for all methods that were not able to be inferred. (Hint: Search the dropkiq_schema.yaml file for the word "CHANGEME" to see what needs manual attention.) Notice that if you run `bundle exec rake dropkiq:schema` again, your changes are saved!
 
 
 #### Ruby on Rails Column to Dropkiq Data Type Mappings
@@ -122,6 +122,45 @@ class ProductDrop < Liquid::Drop
 end
 ```
 
+#### Dropkiq Method Classification
+
+In the event that a liquid method is not an exact match to a column or association, the Dropkiq Ruby Gem will attempt to make a best guess about the data type of the method based on the name. The rules for matching are as follows:
+
+| Method Name Ends With | Dropkiq Data Type |
+| --- | --- |
+| `_id` | `ColumnTypes::Numeric` |
+| `_count` | `ColumnTypes::Numeric` |
+| `?` | `ColumnTypes::Boolean` |
+| `_present` | `ColumnTypes::Boolean` |
+| `_changed` | `ColumnTypes::Boolean` |
+| `description` | `ColumnTypes::Text` |
+| `name` | `ColumnTypes::String` |
+| `password` | `ColumnTypes::String` |
+| `type` | `ColumnTypes::String` |
+| `title` | `ColumnTypes::String` |
+| `to_s` | `ColumnTypes::String` |
+| `to_string` | `ColumnTypes::String` |
+| `_url` | `ColumnTypes::String` |
+| `_email` | `ColumnTypes::String` |
+| `_partial` | `ColumnTypes::String` |
+| `_email_address` | `ColumnTypes::String` |
+| `_uuid` | `ColumnTypes::String` |
+
+The Dropkiq Ruby Gem will also attempt to classify liquid methods by creating a sample instance of the Liquid Drop class to test. The liquid method will be called, and the value will attempt to be classified using the foollowing:
+
+| Value Result | Dropkiq Data Type |
+| --- | --- |
+| `TrueClass` | `ColumnTypes::Boolean` |
+| `FalseClass` | `ColumnTypes::Boolean` |
+| `String` | `ColumnTypes::String` |
+| `Symbol` | `ColumnTypes::String` |
+| `Numeric` | `ColumnTypes::Numeric` |
+| `Date` | `ColumnTypes::DateTime` |
+| `Time` | `ColumnTypes::DateTime` |
+| `DateTime` | `ColumnTypes::DateTime` |
+
+Dropkiq will attempt to classify relationships in the event the method returns a single ActiveRecord object (`ColumnTypes::HasOne`), or a collection or ActiveRecord objects (`ColumnTypes::HasMany`).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/dropkiq.rb

@@ -7,6 +7,8 @@ require "dropkiq/constants"
 
 require "dropkiq/drop_class_analyzer"
 require "dropkiq/drop_method_analyzer"
+require "dropkiq/drop_method_name_classifier"
+require "dropkiq/drop_method_instance_simulator"
 require 'dropkiq/railtie' if defined?(Rails)
 
 module Dropkiq

data/lib/dropkiq/drop_class_analyzer.rb

@@ -52,8 +52,14 @@ module Dropkiq
       default_methods  = (Liquid::Drop.instance_methods + Object.instance_methods)
       instance_methods = (liquid_drop_class.instance_methods - default_methods)
 
+      sample_instance = active_record_class.first
+      sample_drop = begin
+        liquid_drop_class.new(sample_instance)
+      rescue
+      end
+
       instance_methods.inject({}) do |hash, method|
-        analyzer = Dropkiq::DropMethodAnalyzer.new(self, method)
+        analyzer = Dropkiq::DropMethodAnalyzer.new(self, method, sample_drop)
         analyzer.analyze
         hash.merge!(analyzer.to_param)
       end.sort_by { |key| key }.to_h

data/lib/dropkiq/drop_method_analyzer.rb

@@ -1,13 +1,16 @@
 module Dropkiq
   class DropMethodAnalyzer
+    CHANGEME = "CHANGEME"
+
     attr_accessor :drop_class_analyzer, :drop_method,
-      :dropkiq_type, :foreign_table_name
+      :dropkiq_type, :foreign_table_name, :sample_drop
 
     delegate :active_record_class, to: :drop_class_analyzer
 
-    def initialize(drop_class_analyzer, drop_method)
+    def initialize(drop_class_analyzer, drop_method, sample_drop=nil)
       self.drop_class_analyzer = drop_class_analyzer
       self.drop_method = drop_method
+      self.sample_drop = sample_drop
     end
 
     def analyze
@@ -15,15 +18,21 @@ module Dropkiq
         relationship_to_dropkiq_type_classifier
       elsif is_column?
         column_to_dropkiq_type_classifier
+      else
+        Dropkiq::DropMethodNameClassifier.new(drop_method).classify
+      end
+
+      if dropkiq_type.blank?
+        result = Dropkiq::DropMethodInstanceSimulator.new(drop_method, sample_drop).classify
+        self.dropkiq_type = result.dropkiq_type
+        self.foreign_table_name = result.foreign_table_name
       end
     end
 
     def to_param
-      return {} if dropkiq_type.blank?
-
       {
         "#{drop_method}" => {
-          "type"               => dropkiq_type,
+          "type"               => (dropkiq_type.presence || CHANGEME),
           "foreign_table_name" => foreign_table_name
         }
       }
@@ -45,7 +54,7 @@ module Dropkiq
       begin
         self.foreign_table_name = reflection.class_name.constantize.table_name
       rescue
-        puts "WARNING: Could not find #{drop_method} on #{active_record_class.name} (skipping)"
+        puts "WARNING: Could not find #{drop_method} on #{active_record_class.name}"
         return
       end
 

data/lib/dropkiq/drop_method_instance_simulator.rb

@@ -0,0 +1,58 @@
+module Dropkiq
+  class DropMethodInstanceSimulator
+    attr_accessor :drop_method, :sample_drop
+    attr_accessor :dropkiq_type, :foreign_table_name
+
+    def initialize(drop_method, sample_drop=nil)
+      self.drop_method = drop_method.to_s
+      self.sample_drop = sample_drop
+    end
+
+    def classify
+      value = begin
+        sample_drop.try(drop_method)
+      rescue
+      end
+
+      self.dropkiq_type = ruby_data_type_to_dropkiq_type(value)
+      self.dropkiq_type ||= test_for_relationship(value)
+
+      self
+    end
+
+    private
+
+    def test_for_relationship(value)
+      if value.is_a?(ActiveRecord::Base)
+        self.foreign_table_name = value.class.table_name
+        return Dropkiq::HAS_ONE_TYPE
+      elsif value.respond_to?(:first) && value.first.is_a?(ActiveRecord::Base)
+        self.foreign_table_name = value.first.class.table_name
+        return Dropkiq::HAS_MANY_TYPE
+      end
+    end
+
+    def ruby_data_type_to_dropkiq_type(value)
+      case value
+      when NilClass
+      when TrueClass
+        Dropkiq::BOOLEAN_TYPE
+      when FalseClass
+        Dropkiq::BOOLEAN_TYPE
+      when String
+        Dropkiq::STRING_TYPE
+      when Symbol
+        Dropkiq::STRING_TYPE
+      when Numeric
+        Dropkiq::NUMERIC_TYPE
+      when Date
+        Dropkiq::DATE_TIME_TYPE
+      when Time
+        Dropkiq::DATE_TIME_TYPE
+      when DateTime
+        Dropkiq::DATE_TIME_TYPE
+      else
+      end
+    end
+  end
+end

data/lib/dropkiq/drop_method_name_classifier.rb

@@ -0,0 +1,52 @@
+module Dropkiq
+  class DropMethodNameClassifier
+    attr_accessor :drop_method
+
+    def initialize(drop_method)
+      self.drop_method = drop_method.to_s
+    end
+
+    def classify
+      if numeric_type_match?
+        Dropkiq::NUMERIC_TYPE
+      elsif boolean_type_match?
+        Dropkiq::BOOLEAN_TYPE
+      elsif text_type_match?
+        Dropkiq::TEXT_TYPE
+      elsif string_type_match?
+        Dropkiq::STRING_TYPE
+      end
+    end
+
+    private
+
+    def numeric_type_match?
+      drop_method.ends_with?("_id") ||
+        drop_method.ends_with?("_count")
+    end
+
+    def boolean_type_match?
+      drop_method.ends_with?("?") ||
+        drop_method.ends_with?("_present") ||
+        drop_method.ends_with?("_changed")
+    end
+
+    def text_type_match?
+      drop_method.ends_with?("description")
+    end
+
+    def string_type_match?
+      drop_method.ends_with?("name") ||
+        drop_method.ends_with?("password") ||
+        drop_method.ends_with?("type") ||
+        drop_method.ends_with?("title") ||
+        drop_method.ends_with?("to_s") ||
+        drop_method.ends_with?("to_string") ||
+        drop_method.ends_with?("_url") ||
+        drop_method.ends_with?("_email") ||
+        drop_method.ends_with?("_partial") ||
+        drop_method.ends_with?("_email_address") ||
+        drop_method.ends_with?("_uuid")
+    end
+  end
+end

data/lib/dropkiq/tasks/dropkiq/schema.rake

@@ -11,8 +11,10 @@ namespace :dropkiq do
     stdout, stderr = StringIO.new, StringIO.new
     $stdout, $stderr = stdout, stderr
     Dir.glob("#{Rails.root}#{Dropkiq::DEFAULT_MODEL_PATH}/**/*.rb").each do |f|
-      load f
-    rescue
+      begin
+        load f
+      rescue
+      end
     end
     $stdout, $stderr = STDOUT, STDERR
 

data/lib/dropkiq/version.rb

@@ -1,3 +1,3 @@
 module Dropkiq
-  VERSION = "0.1.8"
+  VERSION = "0.1.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropkiq
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.11
 platform: ruby
 authors:
 - Adam Darrah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -160,6 +160,8 @@ files:
 - lib/dropkiq/constants.rb
 - lib/dropkiq/drop_class_analyzer.rb
 - lib/dropkiq/drop_method_analyzer.rb
+- lib/dropkiq/drop_method_instance_simulator.rb
+- lib/dropkiq/drop_method_name_classifier.rb
 - lib/dropkiq/railtie.rb
 - lib/dropkiq/tasks/dropkiq/schema.rake
 - lib/dropkiq/version.rb