wise_gopher 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc88a6090305daa53b83df1cd298531d6209dbb74cce4aa2c1492a2c3987c168
-  data.tar.gz: 874dc19cf652522bdb9ebf89e45543c5ce912dd8a636d6dd01bc7ab7e78e10ec
+  metadata.gz: 1b5ee8812c5f43c35badd034435bc43135bde85326b16aaa943047fe8ba6c6cb
+  data.tar.gz: 5ff89577e0ee88db9eeb45b89dd7a40357f0a2cd0e8cc6eb1c8e68fc2f323f14
 SHA512:
-  metadata.gz: 4b0f65b90b90414aa03e572e33e0d3ac360f886c61afd19dc3b026b9ff0e76c9fd7040b77cf8c1b1bf89dcddd665d36e1125ff5ec27ff21c73d232b42dfeab09
-  data.tar.gz: ed4ceb261617680856ad9896b68b1ac0711ae911edf264d3d14fde7a5b7405b2d6843cd03333be036927fe762e45b7054e023d6f53e353cd19e117f05e451db7
+  metadata.gz: 45dc2fe309a15e395539e80c4e0ccb153382633508eed87d2d8ea8617542da9c9e98c7e31bb564be482a90487f4586ce9615fdac6987255ac91e4c74aeac4911
+  data.tar.gz: 7563bd1ef7407c2ab244776ace9b8ee5a21c14f42cf294a2cda4f6ab00aef2018760f6a86df5c37cd7862f118d024be22648da5bb140afcba592da002cbb786e

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# test file
+.testing.rb

data/Gemfile.lock

@@ -1,35 +1,34 @@
 PATH
   remote: .
   specs:
-    wise_gopher (0.2.0)
-      activerecord (>= 5, < 7)
+    wise_gopher (0.3.2)
+      activerecord (~> 7, >= 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activesupport (6.1.4)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     database_cleaner (1.99.0)
-    diff-lcs (1.4.4)
-    i18n (1.8.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -37,51 +36,52 @@ GEM
     pry-byebug (3.8.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    pry-doc (1.1.0)
+    pry-doc (1.3.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.17.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.4.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     sqlite3 (1.4.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    yard (0.9.26)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -98,4 +98,4 @@ DEPENDENCIES
   wise_gopher!
 
 BUNDLED WITH
-   2.2.20
+   2.3.9

data/README.md

@@ -9,7 +9,7 @@ This gem tries to solve some problems found when you need to execute custom and/
 3. The column types are not always correctly retrieved by ActiveRecord, or sometimes you need a little more ruby treatment on the value before using it.
 
 [This article](https://blog.saeloun.com/2019/10/28/bind-parameters-in-activerecord-sql-queries.html) describe the benefits of using bind parameters with ActiveRecord.
-[This one](https://use-the-index-luke.com/sql/where-clause/bind-parameters) goes further one the subject.
+[This one](https://use-the-index-luke.com/sql/where-clause/bind-parameters) goes further on the subject.
 
 The basic idea of this gem is to provide you a way to declare what your query needs as input, what columns it returns and their type. In returns it will allow you to retrieve the rows from result as an array of plain Ruby objects. It will also dynamically creates a class for the row objects that you can customize or can provide it yourself.
 
@@ -59,9 +59,9 @@ class PopularArticle < WiseGopher::Base
   
   row do
     column :title, :string, transform: :capitalize
-    column :average_rating, :float, -> { round(2) }
+    column :average_rating, :float, transform: -> { round(2) }
     column :published_at, :datetime
-    column :author_username, as: :author
+    column :author_username, :string, as: :author
     
     def to_s
         "Article '#{title}' by #{author} is rated #{"%.2f" % average_rating}/5."
@@ -151,7 +151,7 @@ end
 
 ------
 ## Raw params
-If you need to dinamically interpolate raw SQL in your query, you can use `raw_param`. The value passed with `execute_with` will be interpolated in the base query before inserting the other params.
+If you need to dynamically interpolate raw SQL in your query, you can use `raw_param`. The value passed with `execute_with` will be interpolated in the base query before inserting the other params.
 ```ruby
 class AnnualReport < WiseGopher::Base
     query <<-SQL

data/lib/wise_gopher/base.rb

@@ -5,13 +5,19 @@ require "forwardable"
 module WiseGopher
   # Main inteface of the gem. Class to be inherited by the query class
   class Base
-    def self.inherited(base)
-      base.class_eval do
-        @raw_params = {}
-        @params     = {}
+    def self.inherited(child_class)
+      parent_class = self
+      child_class.extend ClassMethods
+      child_class.set_defaults
+
+      # if child_class is already a WiseGopher::Base
+      child_class.ancestors.include?(Methods) && child_class.class_eval do
+        @raw_params = parent_class.raw_params.deep_dup
+        @params = parent_class.params.deep_dup
+        @row_class = parent_class.row_class
       end
-      base.include Methods
-      base.extend  ClassMethods
+
+      child_class.include Methods
     end
 
     # class methods for WiseGopher::Base
@@ -41,7 +47,7 @@ module WiseGopher
       def row(base = nil, &block)
         @row_class ||= base || define_generic_row_class
 
-        @row_class.include WiseGopher::Row
+        @row_class.include WiseGopher::Row unless @row_class.ancestors.include?(WiseGopher::Row)
 
         @row_class.class_eval(&block) if block_given?
       end
@@ -64,6 +70,11 @@ module WiseGopher
         raise WiseGopher::ArgumentError, required_params.slice(*missing_params) if missing_params.any?
       end
 
+      def set_defaults
+        @raw_params = {}
+        @params = {}
+      end
+
       private
 
       def define_generic_row_class
@@ -90,7 +101,6 @@ module WiseGopher
       def initialize(inputs = {})
         @inputs         = inputs
         @binds          = []
-        @bind_symbol    = WiseGopher.postgresql? ? +"$1" : "?"
         @query_prepared = false
 
         self.class.ensure_all_params_are_given(inputs)
@@ -169,16 +179,20 @@ module WiseGopher
 
       def use_bind_symbol
         if WiseGopher.postgresql?
-          symbol = @bind_symbol.dup
+          symbol = bind_symbol.dup
 
-          @bind_symbol.next!
+          bind_symbol.next!
 
           symbol
         else
-          @bind_symbol
+          bind_symbol
         end
       end
 
+      def bind_symbol
+        @bind_symbol ||= WiseGopher.postgresql? ? +"$1" : "?"
+      end
+
       def ensure_row_class_is_declared
         raise RowClassIsMissing unless row_class
       end

data/lib/wise_gopher/column.rb

@@ -3,21 +3,25 @@
 module WiseGopher
   # Cast query columns and transform value
   class Column
-    attr_reader :name, :type, :alias
+    attr_reader :name, :alias
 
     def initialize(name, type_symbol, transform: nil, as: nil)
-      @alias     = as&.to_s.freeze || name.to_s.freeze
-      @name      = name.to_s.freeze
-      @type      = ActiveRecord::Type.lookup type_symbol
+      @alias = as&.to_s.freeze || name.to_s.freeze
+      @name = name.to_s.freeze
+      @type_symbol = type_symbol
       @transform = transform&.to_proc
     end
 
     def cast(value)
-      casted_value = @type.deserialize(value)
+      casted_value = type.deserialize(value)
 
       @transform ? transform_value(casted_value) : casted_value
     end
 
+    def type
+      @type ||= ActiveRecord::Type.lookup type_symbol
+    end
+
     def define_getter(row_class)
       column = self
 
@@ -32,6 +36,8 @@ module WiseGopher
 
     private
 
+    attr_reader :type_symbol
+
     def transform_value(value)
       case @transform.arity
       when 0 then value.instance_exec(&@transform)

data/lib/wise_gopher/param.rb

@@ -3,11 +3,11 @@
 module WiseGopher
   # Register query's params and build query's bind variables
   class Param
-    attr_reader :name, :type
+    attr_reader :name
 
     def initialize(name, type_symbol, transform = nil)
-      @name      = name.to_s.freeze
-      @type      = ActiveRecord::Type.lookup type_symbol
+      @name = name.to_s.freeze
+      @type_symbol = type_symbol
       @transform = transform&.to_proc
     end
 
@@ -17,8 +17,14 @@ module WiseGopher
       ActiveRecord::Relation::QueryAttribute.new(name, prepared_value, type)
     end
 
+    def type
+      @type ||= ActiveRecord::Type.lookup type_symbol
+    end
+
     private
 
+    attr_reader :type_symbol
+
     def transform_value(value)
       case @transform.arity
       when 0 then value.instance_exec(&@transform)

data/lib/wise_gopher/version.rb

@@ -3,8 +3,8 @@
 module WiseGopher
   module VERSION
     MAJOR = 0
-    MINOR = 2
-    PATCH = 0
+    MINOR = 3
+    PATCH = 2
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/wise_gopher.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 5", "< 7"
+  spec.add_dependency "activerecord", ">= 5", "~> 7"
 
   spec.add_development_dependency "database_cleaner", "~> 1.5"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wise_gopher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - PageHey
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,7 +17,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7'
   type: :runtime
@@ -27,7 +27,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
@@ -210,7 +210,7 @@ metadata:
   homepage_uri: https://github.com/Pagehey/wise_gopher
   source_code_uri: https://github.com/Pagehey/wise_gopher
   changelog_uri: https://github.com/Pagehey/wise_gopher/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,8 +225,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Encapsulate raw SQL queries and return result as plain Ruby objects, using
   ActiveRecord.