halumi 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f073aad03ffa24817de5c813b8940adf1b9e3bb4dc84016d4263c3c636f8c03
-  data.tar.gz: 0741c790a439a10e55ce0dffc66a1c6f99ac0f66c054e93392db6b3c2e5bba37
+  metadata.gz: d1b49d5233260f9d57b96dea92baa8eb3e441ed7647d6738227237735a053eeb
+  data.tar.gz: e2ce02794b63f2db20303a6cfdb27043a914de8da515e2b90139fa42959b2f9c
 SHA512:
-  metadata.gz: 200ecb3c6c8822e5c960ab81db3fff314ec0b53d5463623524dbee0c94f4a5770baf0629ae964dfa2a0ed15b3191adae0ef41c3a203d9e01a2bdf65847e99909
-  data.tar.gz: 7bc729f135d3b6e7b5a8c5b54263bfdd0c9d13c224b4e5216353b80bd87eae676253677094c34f707baeb8f0580e5f3a6b532149dc4767d360122c34ede054ef
+  metadata.gz: d3b9bed53256c5d7aaeab098bb78a09cf3410bcb9d3b6dc1bb0fe4e863f1a0f046ce60ceaedf44dad15317f473e05ed78f203c61540fa3af55baa21bc751dd22
+  data.tar.gz: 3e0804e11cd4b2693d28414ad7ebb0ff833f2564c8a2d3559cbd82632ad728d0caeffa47953933a0f5e6eeec6c26252dbc3859c933a7757bef59a9ca71d29fc6

data/README.md

@@ -1,8 +1,25 @@
 # Halumi
+![Gem](https://img.shields.io/gem/v/halumi.svg) ![GitHub](https://img.shields.io/github/license/PiotrWald/halumi.svg)
+
+One of the patterns in Rails development I find usefull are query objects.
+They are essantialy service objects returning a ActiveRecord Relation. Using them
+results in less code cluttering your controllers and models. Plus you can easily
+unit test each of your queries.
+
+This Gem adds simple DSL allowing you to build query objects and than merge
+them into one query (ActiveRecord::Relation)
+
+One of the cool patterns in Rails development are query objects.
+They are essantialy service objects returning a ActiveRecord Relation. Using them
+results in less code cluttering your controllers and models. Plus you can easily
+unit test each of your queries.
+
+This Gem adds simple DSL allowing you to build query objects and than combining
+them into one query that will be executed against your database
 
 ## Example usage
 
-### Define your query classes
+### Define your 'super' query combining 3 subqueries
 
 ```Ruby
 class ArticlesQuery < Halumi::Query
@@ -19,20 +36,22 @@ class PaginationQuery < Halumi::Query
   param :per_page
   param :page
 
-  def call
+  def execute
     relation.page(page).per(per_page)
   end
 end
 ```
 ```Ruby
 class PublishedArticlesQuery
-  relation.where(published: true)
+  def execute
+    relation.where(published: true)
+  end
 end
 ```
 
 ```Ruby
 class OrderArticlesQuery < Halumi::Query
-  def call
+  def execute
     relation.order(:created_at)
   end
 end
@@ -41,6 +60,8 @@ end
 
 ### Run your query
 
+This will return published articles, paginated and sorted by creation time
+
 ```Ruby
 
   params = { page: 2, per_page: 10 }

data/lib/halumi/query.rb

@@ -1,6 +1,7 @@
 module Halumi
   class Query
     @subqueries = []
+    @defined_params = []
     @relation = nil
 
     attr_reader :relation
@@ -8,6 +9,7 @@ module Halumi
     def self.inherited(klass)
       klass.instance_variable_set(:@subqueries, @subqueries.clone)
       klass.instance_variable_set(:@relation, @relation)
+      klass.instance_variable_set(:@defined_params, [])
     end
 
     def self.model(model)
@@ -18,10 +20,12 @@ module Halumi
       @subqueries << subquery
     end
 
-    def self.param(param_name, &block)
-      block ||= proc { @params[param_name] }
+    def self.param(param_name, type = nil, &block)
+      block ||= proc { type ? type[@params[param_name]] : @params[param_name] }
 
       define_method(param_name, block)
+
+      @defined_params << param_name
     end
 
     def initialize(params = {}, relation = nil)
@@ -31,11 +35,21 @@ module Halumi
     end
 
     def call
-      respond_to?(:execute) ? execute : merge_subqueries
+      respond_to?(:execute) ? safe_execute : merge_subqueries
     end
 
     private
 
+    def safe_execute
+      validate_params && execute
+    rescue Dry::Types::ConstraintError
+      relation
+    end
+
+    def validate_params
+      class_defined_params.each { |p| public_send(p) }
+    end
+
     def merge_subqueries
       @subqueries.map(&:call).reduce(&:merge)
     end
@@ -53,5 +67,9 @@ module Halumi
     def class_relation
       self.class.instance_variable_get(:@relation)
     end
+
+    def class_defined_params
+      self.class.instance_variable_get(:@defined_params)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: halumi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Piotr Wald
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,9 +72,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="