stairwell 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9eb7f5f503d74ee340bc8e9011dcf587604c20d6fd959a5b006def17769b71a
-  data.tar.gz: 6bcbbc5866685ef8d767428a33b5862b58952a849e37237f869622ba720806d0
+  metadata.gz: c3a4932425e6273ba11f06755995cc39d7045566808bd60870e5ed3ae866bc1a
+  data.tar.gz: 5694267cbbc05428eb8161c244d7d9ead34c21ee6999156a3046c08a736e524d
 SHA512:
-  metadata.gz: fc068d002df5eddc9026ae6ce34c786697712c2b475255fdcf5e0a0e8eaedbe9b3dc138f505ca6328342cc2e7a99648fd78087ae26b6946a481ddaefec35d943
-  data.tar.gz: 8d9b86448fe37776e4aef1c4a7620946af302f016516c06fe931975e6d00b9128ee1ce2d087567850bc384ff0fa147fbbf82a93cb6a2e94de9daf09918e009c4
+  metadata.gz: fdcb61bf3e077028063dc94ecdef023aaccc709fd326cdce4354af181be15c84fbd805b492a324bd6d2117a84c6981b481835cf5ebb879ae84fda9ae2077cbca
+  data.tar.gz: cbb08179152c8bb7205c2d469afe0794e8505757bd65b248e53e7d6f6639fd42fa87a0523bd42993a64e97c47363d702bb90d48f72540ed63468624a49a5b4f4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stairwell (0.5.0)
+    stairwell (0.6.0)
       activerecord (>= 4.2.11)
       rake
       sqlite3

data/README.md

@@ -83,6 +83,22 @@ They types of the binds are validated too.
 The names binds in your sql are also validated.
 All types are quoted using ActiveRecord quoting, which will be different depending on your database type (Mysql, postgres etc.)
 
+## SQL files
+Support for sql files is being trialed. If you would like to reference raw sql file instead of quoting the sql in the ruby file, you can. You just have to place the file adjacent to the ruby file and name them the same eq: ruby file is `users_count.rb` the file would need to be in the same directory and named `users_count.sql`. You also need to set the path in your config:
+
+```ruby
+# in ruby project:
+Stairwell.configure do |config|
+  config.path = './app/queries/'
+end
+
+# in Rails:
+Stairwell.configure do |config|
+  config.path = "#{Rails.root}/app/queries"
+end
+
+```
+
 ## Supported Types
 
 | Type         | Values Accepted      | Info                                                                                                 |

data/lib/stairwell/query.rb

@@ -9,6 +9,7 @@ module Stairwell
       end
 
       def sql(**args)
+        set_sql_string_from_file
         raise InvalidBindCount, 'Incorrect amount of args passed' if args.keys.sort != all_validations.keys.sort
 
         @type_hash = args.each_with_object({}) do |(name, value), hash|
@@ -18,7 +19,7 @@ module Stairwell
       end
 
       def query(string)
-        @sql_string = string.squish
+        @sql_string ||= string.squish
       end
 
       private
@@ -28,6 +29,25 @@ module Stairwell
       def transformer
         BindTransformer.new(sql_string, type_hash)
       end
+
+      def set_sql_string_from_file
+        return unless Stairwell.configuration.path && File.exist?(associated_sql_file)
+
+        file = File.read(associated_sql_file)
+        @sql_string = file&.squish
+      end
+
+      def associated_sql_file
+        "#{Stairwell.configuration.path}#{camelized_class}.sql"
+      end
+
+      def camelized_class
+        self.to_s.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+          .tr("-", "_")
+          .downcase
+      end
     end
   end
 end

data/lib/stairwell/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stairwell
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/stairwell.rb

@@ -20,6 +20,16 @@ module Stairwell
     table_name: 'Stairwell::Types::TableNameType'
   }.freeze
 
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+
   # for development and testing
   unless defined?(Rails)
     ::ActiveRecord::Base.establish_connection(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairwell
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - tobyond
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord