rql 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 084bde9b357cebc0e8e7d46ccddc7158bd1b0365
-  data.tar.gz: 87759ddc7eaf7f44d495d148cb1d6ef2039b1ee2
+  metadata.gz: 73bfb99910e53072a8efb800ec7e1d16ce2a6c9c
+  data.tar.gz: 70e3691955083453373248274ed088aa18298290
 SHA512:
-  metadata.gz: 7c05432fb7fe1f44af0eea3f5ff4767debf22a3d18f07658af5358587e4418719ff1333cb875d5eb3e8b8753b65b15aa8cf2d6f8166c52e6ed03745552510636
-  data.tar.gz: 65573f3f235301296dcf4240374c2aa90b8e9476ae4762860cd140f4b088de9ca06bb30989bdbdb61c4500e0d052664bcc43f0a4c23b9102530702e2d3fc7463
+  metadata.gz: 1f22889e8798227e85c0fcba82f12151b88ee40879053d2063ec9aa986783acbf0dec5f61c06f9c80fdae58a2215696238ee812feabcf6116eee8aeb1470ecb9
+  data.tar.gz: 286d67606f9049498a480d88b4f3e1826abede59c14f12354d57990cc5d3b6ff4b6475e94c8e4b63741f8cfb48b67761412f2f607c9a46ff685ec34ddc603e98

data/.yardopts

@@ -0,0 +1 @@
+--plugin activesupport-concern

data/lib/rql/dsl/comparisons.rb

@@ -27,11 +27,11 @@ module Rql
         Context.new(@model, arel.gteq(value))
       end
 
-      def starts_with?(value)
+      def start_with?(value)
         Context.new(@model, arel.matches("#{value}%"))
       end
 
-      def ends_with?(value)
+      def end_with?(value)
         Context.new(@model, arel.matches("%#{value}"))
       end
 

data/lib/rql/dsl/context.rb

@@ -7,6 +7,8 @@ module Rql
       include Orders
       include Logic
 
+      attr_accessor :arel, :scope, :model
+
       def initialize(scope, arel, name = nil)
         @scope = scope
         @model = scope.unscoped
@@ -14,8 +16,8 @@ module Rql
         @name = name
       end
 
-      def arel
-        @arel
+      def context_name
+        @name
       end
 
       def build_context(name)

data/lib/rql/queryable.rb

@@ -5,7 +5,7 @@ module Rql
     extend ActiveSupport::Concern
 
     class_methods do
-      # Gets and RQL scope object for access to rql query methods
+      # Gets an RQL scope object for access to rql query methods
       #
       # @return [Rql::Scope::RqlScope] object wrapping the current scope
       def rql
@@ -15,7 +15,7 @@ module Rql
       # Evaluates a block of code against the RQL DSL
       #
       # @param alias_derived_attr [Boolean] value specifying if derived attributes will be assigned an alias
-      # @param &block [Block] the code block to be converted to sql
+      # @yield the code block to be converted to sql
       # @return [Rql::Dsl::Context] object wrapping arel for the evaluated block of code
       def eval_rql(alias_derived_attr = false, &block)
         Dsl::Base.new(self, alias_derived_attr).instance_eval(&block)
@@ -24,7 +24,7 @@ module Rql
       # Defines a derived attribute on a model
       #
       # @param name [Symbol] the name of the derived attribute
-      # @param &block [Block] the code to derive the attribute
+      # @yield the code to derive the attribute
       # @!macro [attach] derive_attr
       #   @return [Object] the value of the derived attribute
       def derive_attr(name, &block)
@@ -37,7 +37,7 @@ module Rql
 
       # Preloads the specified derived attributes from the database
       #
-      # @param *attributes [Array<Symbol>] the attributes to be preloaded
+      # @param attributes [Array<Symbol>] the attributes to be preloaded
       # @return scope including derived attributes
       def derive(*attributes)
         rql.select(self.arel_table[Arel.star], *attributes).all
@@ -45,7 +45,7 @@ module Rql
 
       # Gets the derived attributes defined on the model
       #
-      # @returns [Hash<Symbol, Proc>] hash of derived attributes indexed by name
+      # @return [Hash<Symbol, Proc>] hash of derived attributes indexed by name
       def derived_attributes
         @derive_attribute ||= {}
       end

data/lib/rql/scope/block_methods.rb

@@ -1,22 +1,42 @@
 module Rql
   module Scope
-    class BlockMethods < MethodGroup
+    module BlockMethods
+      # Filters scope based on specified conditions
+      #
+      # @yield RQL block defining the conditions to filter on
+      # @return [Rql::Scope::RqlScope] a new scope filtered by the specified conditions
       def where(&block)
         scope.where(scope.eval_rql(&block).arel)
       end
 
+      # Specifies attributes to be selected from the database
+      #
+      # @yield RQL block defining the attributes to be selected
+      # @return [Rql::Scope::RqlScope] a new scope selecting the specified attributes
       def select(&block)
         scope.select(*build_attributes(true, &block))
       end
 
+      # Orders by specified attributes
+      #
+      # @yield RQL block defining the attributes order by
+      # @return [Rql::Scope::RqlScope] a new scope ordered by the specified attributes
       def order(&block)
         scope.order(*build_attributes(&block))
       end
 
+      # Joins to the specified associated models
+      #
+      # @yield RQL block defining the associations to join to
+      # @return [Rql::Scope::RqlScope] a new scope joining the specified associations
       def joins(&block)
         scope.joins(*build_join_path(&block))
       end
 
+      # Includes the specified associated models
+      #
+      # @yield RQL block defining the associations to include
+      # @return [Rql::Scope::RqlScope] a new scope including the specified associations
       def includes(&block)
         scope.includes(*build_join_path(&block))
       end
@@ -34,5 +54,9 @@ module Rql
           attributes.map(&:arel)
         end
     end
+
+    class BlockMethodGroup < MethodGroup
+      include BlockMethods
+    end
   end
 end

data/lib/rql/scope/param_methods.rb

@@ -1,22 +1,42 @@
 module Rql
   module Scope
-    class ParamMethods < MethodGroup
+    module ParamMethods
+      # Filters scope based on specified conditions
+      #
+      # @param conditions [Hash] A hash of attribute => value conditions to filter on. Use nested hashes to filter on associations. Supports ranges and arrays as values.
+      # @return [Rql::Scope::RqlScope] a new scope filtered by the specified conditions
       def where(**conditions)
         scope.where(build_conditions(conditions))
       end
 
+      # Specifies attributes to be selected from the database
+      #
+      # @param attributes [Array] the attributes to select
+      # @return [Rql::Scope::RqlScope] a new scope selecting the specified attributes
       def select(*attributes)
         scope.select(*attributes.map{|attr| scope.derived_attributes[attr] ? scope.eval_rql(&scope.derived_attributes[attr]).as(attr).arel : attr})
       end
 
+      # Orders by specified attributes
+      #
+      # @param attributes [Array] the attributes to order by. Attributes may be a symbol, sql string or a hash specifying attribute and order.
+      # @return [Rql::Scope::RqlScope] a new scope ordered by the specified attributes
       def order(*attributes)
         scope.order(*build_order(attributes))
       end
 
+      # Joins to the specified associated models
+      #
+      # @param attributes [Array] the associations to join to. Use nested hashes to chain joins through associations.
+      # @return [Rql::Scope::RqlScope] a new scope joining the specified associations
       def joins(*attributes)
         scope.joins(*attributes)
       end
 
+      # Includes the specified associated models
+      #
+      # @param attributes [Array] the associations to include. Use nested hashes to include associations of associations.
+      # @return [Rql::Scope::RqlScope] a new scope including the specified associations
       def includes(*attributes)
         scope.includes(*attributes)
       end
@@ -54,5 +74,9 @@ module Rql
           order_by.flatten
         end
     end
+
+    class ParamMethodGroup < MethodGroup
+      include ParamMethods
+    end
   end
 end

data/lib/rql/scope/rql_scope.rb

@@ -1,12 +1,19 @@
 module Rql
   module Scope
     class RqlScope
+      # @!parse include Rql::Scope::ParamMethods
+      # @!parse include Rql::Scope::BlockMethods
+
+      # @param scope [ActiveRecord::Relation] the underlying scope to wrap
       def initialize(scope)
-        @block_methods = BlockMethods.new(scope)
-        @param_methods = ParamMethods.new(scope)
+        @block_methods = BlockMethodGroup.new(scope)
+        @param_methods = ParamMethodGroup.new(scope)
         @scope = scope
       end
 
+      # Gets the underlying ActiveRecord Relation object for the scope
+      #
+      # @return [ActiveRecord::Relation] the underlying arel object
       def scope
         @scope
       end
@@ -28,15 +35,25 @@ module Rql
           super
       end
 
+      # Creates a new scope merging the current scope with the other scope
+      #
+      # @param [Rql::Scope::RqlScope, ActiveRecord::Relation] other the scope to merge with the current one.
+      # @return [Rql::Scope::RqlScope] the new merged scope
       def merge(other)
         other = other.scope if other.is_a?(RqlScope)
         RqlScope.new(scope.merge(other))
       end
 
+      # Gets the underlying arel object for the scope
+      #
+      # @return [Arel::SelectManager] the underlying arel object
       def arel
         scope.arel
       end
 
+      # Executes the scope against the database returning the results as an array
+      #
+      # @return [Array] the results as an array
       def to_a
         scope.to_a
       end

data/lib/rql/version.rb

@@ -1,3 +1,3 @@
 module Rql
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/rql.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pg"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard-activesupport-concern"
 
   spec.add_runtime_dependency "activerecord", ">= 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rql
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Lief Nikkel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +121,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile