kweerie 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11c69ed8356612d3a1df5dfb98b4751061db706908f7b2efe6ace375f53c73e
-  data.tar.gz: b33644c5b64bb941bf88bf6207ced00706e84a1c83c2b60fa9c7dddc680dd0fe
+  metadata.gz: d8c4f949ad0ee144a37015f2444ad19721390ee94a59b1fc118599409b6b0f0a
+  data.tar.gz: a8b741b11e8dd572f6fccba9f06becbb75b06f0444e879f43b21f70d164d2ba7
 SHA512:
-  metadata.gz: 9f05d4db4050c840ac87c60b60e44dd27413fc3fee685cd81fd5320d6bb9d37f01ee5a1f29691989f1ec4f3de2a566d1a8fd0057696b54982bdd012170a0ea2b
-  data.tar.gz: 11560ae4acff559585472f020d29d0367ca431cd3f9398cfb75aa1e27b6a08057e8f6b1d5270b7f6ef043551c9f15d3b95434d586400390c512c75b410dc7661
+  metadata.gz: 368206d1376231a56d197911245878f8efdf8eb33f86f47135c079f2d3c28b2ac5a70786b7bafaa694b980f6f192ea6ac2d43ffcdb41f77bbd24aee295c7b9c4
+  data.tar.gz: 82c8cb0e9a1171f3a0e90b0db23ebc5f35e2b82401f4db2066b3903db383b8e08f619ab25edefbc0bea4ebab93fde9072d86895bfa864a1f793c4370f5f02f03

data/.rake_tasks~

@@ -0,0 +1,20 @@
+build
+build:checksum
+clean
+clobber
+default
+install
+install:local
+release[remote]
+release:guard_clean
+release:rubygem_push
+release:source_control_push[remote]
+rubocop
+rubocop:auto_correct
+rubocop:autocorrect
+rubocop:autocorrect_all
+test
+test:cmd
+test:deps
+test:isolated
+test:slow

data/README.md

@@ -74,6 +74,96 @@ user.name         # => "Claude"
 user.created_at   # => 2024-01-01 00:00:00 +0000 (Time object)
 ```
 
+## Querying
+
+Kweerie provides two main ways to execute queries based on whether they have parameters:
+
+### Parameterized Queries
+
+When your query needs parameters, use the `.with` method:
+
+```ruby
+class UsersByDepartment < Kweerie::Base
+  bind :department, as: '$1'
+  bind :active, as: '$2'
+end
+
+# app/queries/users_by_department.sql
+SELECT *
+FROM users
+WHERE department = $1
+  AND active = $2;
+
+# Using the query
+users = UsersByDepartment.with(
+  department: 'Engineering',
+  active: true
+)
+```
+
+### Parameter-free Queries
+
+For queries that don't require any parameters, you can use the more semantically appropriate `.all` method:
+
+```ruby
+class AllUsers < Kweerie::Base
+end
+
+# app/queries/all_users.sql
+SELECT *
+FROM users
+WHERE active = true
+ORDER BY created_at DESC;
+
+# Using the query
+users = AllUsers.all
+```
+
+The `.all` method provides a cleaner interface when you're not binding any parameters. It will raise an error if you try to use it on a query class that has parameter bindings:
+
+```ruby
+# This will raise an ArgumentError
+UsersByDepartment.all  
+# => ArgumentError: Cannot use .all on queries with bindings. Use .with instead.
+```
+
+### Choosing Between .all and .with
+
+- Use `.all` when your SQL query is completely static with no parameters
+- Use `.with` when you need to pass parameters to your query
+- Even for parameterized queries, you can use `.with` without arguments if all parameters are optional
+
+```ruby
+# A query with no parameters
+class RecentUsers < Kweerie::Base
+end
+RecentUsers.all  # ✓ Clean and semantic
+RecentUsers.with # ✓ Works but less semantic
+
+# A query with parameters
+class UsersByStatus < Kweerie::Base
+  bind :status, as: '$1'
+end
+UsersByStatus.all                    # ✗ Raises ArgumentError
+UsersByStatus.with(status: 'active') # ✓ Correct usage
+```
+
+Both methods work with `Kweerie::Base` and `Kweerie::BaseObjects`, returning arrays of hashes or objects respectively:
+
+```ruby
+# Returns array of hashes
+class AllUsers < Kweerie::Base
+end
+users = AllUsers.all
+# => [{"id" => 1, "name" => "Claude"}, ...]
+
+# Returns array of objects
+class AllUsers < Kweerie::BaseObjects
+end
+users = AllUsers.all
+# => [#<AllUsers id=1 name="Claude">, ...]
+```
+
 ### Automatic Type Casting
 
 BaseObjects automatically casts common PostgreSQL types to their Ruby equivalents:
@@ -147,7 +237,7 @@ user.changes                   # => Hash of changes with [old, new] values
 user.original_attributes       # => Original attributes from DB
 ```
 
-## PostgreSQL Array Support
+### PostgreSQL Array Support
 
 BaseObjects handles PostgreSQL arrays by converting them to Ruby arrays with proper type casting:
 
@@ -167,7 +257,7 @@ user.tags                 # => ["ruby", "rails"]
 user.scores              # => [98.5, 87.2, 92.0]
 ```
 
-## Performance Considerations
+### Performance Considerations
 
 BaseObjects creates a unique class for each query result set, with the following optimizations:
 
@@ -179,7 +269,7 @@ BaseObjects creates a unique class for each query result set, with the following
 
 For queries where you don't need the object interface, use `Kweerie::Base` instead for slightly better performance.
 
-### Rails Generator
+## Rails Generator
 
 If you're using Rails, you can use the generator to create new query files:
 
@@ -193,7 +283,7 @@ rails generate kweerie UserSearch email name
 
 This will create both the Ruby class and SQL file with the appropriate structure.
 
-### Configuration
+## Configuration
 
 By default, Kweerie uses ActiveRecord's connection if available. You can configure this and other options:
 
@@ -222,7 +312,7 @@ end
 - ✅ Configurable connection handling
 - ✅ Parameter validation
 
-## Why Kweerie?
+### Why Kweerie?
 
 - **SQL Views Overkill**: When a database view is too heavy-handed but you still want to keep SQL separate from Ruby
 - **Version Control**: Keep your SQL under version control alongside your Ruby code
@@ -230,11 +320,11 @@ end
 - **Simple Interface**: Clean, simple API for executing parameterized queries
 - **Rails Integration**: Works seamlessly with Rails and ActiveRecord
 
-## Development
+### Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
 
-## Contributing
+### Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -242,7 +332,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-## License
+### License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/lib/kweerie/base.rb

@@ -45,6 +45,12 @@ module Kweerie
         result.to_a
       end
 
+      def all
+        raise ArgumentError, "Cannot use .all on queries with bindings. Use .with instead." if bindings.any?
+
+        with
+      end
+
       private
 
       def validate_params!(params)

data/lib/kweerie/base_objects.rb

@@ -20,7 +20,7 @@ module Kweerie
       private
 
       def generate_result_class(attribute_names)
-        @generate_result_class ||= Class.new do
+        @generate_result_class ||= Class.new(self) do
           # Include comparison and serialization modules
           include Comparable
 
@@ -29,6 +29,20 @@ module Kweerie
             attr_reader name
           end
 
+          define_method :initialize do |attrs|
+            # Store both raw and casted versions
+            @_raw_original_attributes = attrs.dup
+            @_original_attributes = attrs.transform_keys(&:to_s).transform_values do |value|
+              type_cast_value(value)
+            end
+
+            attrs.each do |name, value|
+              casted_value = type_cast_value(value)
+              instance_variable_set("@#{name}", casted_value)
+            end
+            super() if defined?(super)
+          end
+
           define_method :type_cast_value do |value|
             case value
             when /^\d{4}-\d{2}-\d{2}( \d{2}:\d{2}:\d{2})?$/ # DateTime check
@@ -64,17 +78,6 @@ module Kweerie
             end
           end
 
-          define_method :initialize do |attrs|
-            # Store original attributes with the same type casting
-            @_original_attributes = attrs.transform_keys(&:to_s).transform_values do |value|
-              type_cast_value(value)
-            end
-
-            attrs.each do |name, value|
-              casted_value = type_cast_value(value)
-              instance_variable_set("@#{name}", casted_value)
-            end
-          end
           define_method :parse_pg_array do |value|
             # Remove the curly braces
             clean_value = value.gsub(/^{|}$/, "")
@@ -115,7 +118,7 @@ module Kweerie
             attrs = attribute_names.map do |name|
               "#{name}=#{instance_variable_get("@#{name}").inspect}"
             end.join(" ")
-            "#<#{self.class.name || "Record"} #{attrs}>"
+            "#<#{self.class.superclass.name} #{attrs}>"
           end
 
           # Hash-like access
@@ -184,6 +187,11 @@ module Kweerie
             @_original_attributes
           end
 
+          # Raw attributes access
+          define_method :raw_original_attributes do
+            @_raw_original_attributes
+          end
+
           # ActiveModel-like changes tracking
           define_method :changed? do
             to_h != @_original_attributes

data/lib/kweerie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kweerie
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kweerie
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Toby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rake_tasks~"
 - ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt