xquery 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c136c8a16f768441bc0e2dc4e26e84a2376454da
-  data.tar.gz: d43cc44d95877c754849b0dac45c29866ee37191
+  metadata.gz: 876688b968422788335514201e580c31a562daf3
+  data.tar.gz: 5ed3c53f8347b42cfd3fef711512fe49d6b2a005
 SHA512:
-  metadata.gz: 1032c489a451dc1f3f32371a7bbc1ddcd095eb2534103c5e1b02fcd8a8f3c5109c6054687c1c8ff87fe089bd34b3727a0fdf7bd89148d301cfd71dea2e859a4b
-  data.tar.gz: 8a0b8a61c0aeb65377c671573cea95cf1b5b2c4f123ab044114d4bf69746fb2669250e5051be5d989de23362df1276c90e0bc4b0c6903c5d41f053fccd069323
+  metadata.gz: 95462d4e6f98c48e113a046a664ba08b2acb5919c886a836c95781856beb91ecb61576c9ca958a60ea02dbb79a42e788d6946bcdb24842e937330794e42db617
+  data.tar.gz: bafcc91a9b266af4a91388238cd289fd4ee019d36633dcb37bbff6fe11fd63ed317041a722d961bcc56c2775b06d993662393e3bacf12c9edec60689033d5042

data/lib/xquery.rb

@@ -4,7 +4,16 @@ require 'active_support'
 # convert it in a builder classes
 # see [README.md] for more information
 module XQuery
+  autoload :Abstract, 'xquery/abstract'
+  autoload :QuerySuperclassChanged, 'xquery/errors'
+  autoload :Generic, 'xquery/generic'
+  autoload :QueryProxy, 'xquery/query_proxy'
+  autoload :VERSION, 'xquery/version'
 end
 
-require 'xquery/version'
-require 'xquery/generic'
+# Allows you to do all query magic on a generic object
+# @param model [Object] any object
+# @yield block where instance will be yielded
+def XQuery(model)
+  XQuery::Generic.with(model) { |instance| yield(instance) }
+end

data/lib/xquery/abstract.rb

@@ -5,22 +5,27 @@ require 'xquery/errors'
 
 module XQuery
   # Abstract superclass, should be inherited, not used
+  # @attr query
+  #   contains current state of wrapped query
   class Abstract
     class_attribute :query_superclass
+    self.query_superclass = Object
+
+    attr_reader :query
 
     # Yields instance inside block. I suggest to name it `q`
-    # @param args [Array(Object)] array of arguments would be passed to
-    # @param block [#to_proc] block to witch instance would be yielded
-    def self.with(*args, &block)
-      instance = new(*args)
-      block.call(instance)
-      instance.query
+    # @param args [Array(Object)]
+    #   array of arguments would be passed to `new`
+    # @yield [XQuery::Abstract] new intance
+    # @return resulting query
+    def self.with(*args)
+      new(*args).with { |instance| yield(instance) }
     end
 
     # Defines `method`, `__method` and `q.method`.
-    # Both of wich changes query to query.method
+    # Both of witch changes query to query.method
     # @param name [#to_sym] name of method on query
-    # @param as [#to_sym] name of method defined
+    # @option as [#to_sym] name of method defined
     def self.wrap_method(name, as: name)
       define_method(as) { |*args, &block| _update_query(name, *args, &block) }
       alias_on_q(as, true)
@@ -51,13 +56,12 @@ module XQuery
     end
 
     # inherited classes should also have their query_proxies inherited
+    # @api private
+    # @param child [Class] class inheriting this
     def self.inherited(child)
       child.instance_variable_set(:@query_proxy, Class.new(query_proxy))
     end
 
-    # contains current state of wrapped query
-    attr_reader :query
-
     # @param query [Object] generic query
     def initialize(query)
       self.query = query
@@ -65,10 +69,10 @@ module XQuery
     end
 
     # Yields iteself inside block. I suggest to name it `q`
-    # @param block [#to_proc] block to whitch instance would be yielded
+    # @yield [XQuery::Abstract] itself
     # @return [Object] query
-    def with(&block)
-      block.call(self)
+    def with
+      yield(self)
       query
     end
 
@@ -85,17 +89,17 @@ module XQuery
     end
 
     # Yields query inside block
-    # @param block [#to_proc]
+    # @yield query
     # @return [XQuery::Abstract] self
-    def apply(&block)
-      self.query = block.call(query)
+    def apply
+      self.query = yield(query)
       self
     end
 
     private
 
-    # Private Api!
     # Updates query by calling method on it and storing the result
+    # @api private
     # @return [XQuery::Abstract] self
     def _update_query(method, *args, &block)
       apply { |x| x.public_send(method, *args, &block) }
@@ -105,7 +109,7 @@ module XQuery
     # @raise XQuery::QuerySuperclassChanged
     def query=(x)
       unless x.is_a?(query_superclass)
-        fail QuerySuperclassChanged.new(x, query_superclass)
+        raise QuerySuperclassChanged.new(x, query_superclass)
       end
 
       @query = x

data/lib/xquery/errors.rb

@@ -1,10 +1,11 @@
 module XQuery
   # raised when superclass of query changed
+  # @attr result
+  #   query on which constraint failed
+  # @attr [Class] expectation
+  #   expected superclass of query
   class QuerySuperclassChanged < StandardError
-    # query on which constraint failed
     attr_reader :result
-
-    # expected superclass of query
     attr_reader :expectation
 
     # @param result [Object] query on which constraint failed

data/lib/xquery/generic.rb

@@ -3,9 +3,6 @@ require 'xquery/abstract'
 module XQuery
   # delegates all operations to model
   class Generic < Abstract
-    # never used but defined in case of need
-    self.query_superclass = Object
-
     # all missing methods would be delegated to query
     # and processed as wrappers process them
     def method_missing(name, *args, &block)
@@ -26,10 +23,3 @@ module XQuery
     end
   end
 end
-
-# Allows you to do all query magic on a generic object
-# @param model [Object] any object
-# @param block [#to_proc] block where instance will be yielded
-def XQuery(model, &block)
-  XQuery::Generic.with(model, &block)
-end

data/lib/xquery/query_proxy.rb

@@ -1,15 +1,16 @@
 module XQuery
   # This proxy can be used to access raw wrappers inside classes,
   # inherited from XQuery::Abstract
+  # @attr instance [XQuery::Abstract]
+  #   Wrapped instance
   class QueryProxy
-    # @param instance [Xquery::Abstract] instance to delegate methods
+    # @param instance [XQuery::Abstract] instance to delegate methods
     def initialize(instance)
       self.instance = instance
     end
 
     private
 
-    # instance of Xquery::Abstract
     attr_accessor :instance
   end
 end

data/lib/xquery/version.rb

@@ -1,4 +1,4 @@
 module XQuery
   # defines XQuery version
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: xquery
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - jelf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -30,72 +30,72 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0.47'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -109,104 +109,71 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 2.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-description: |
-  # XQuery
-  XQuery is designed to replace boring method call chains and allow to easier
-  convert it in a builder classes
-  [![Build Status](https://travis-ci.org/JelF/xquery.svg?branch=master)](https://travis-ci.org/JelF/xquery)
-  ## Usage of `XQuery` function
-  `Xquery` is a shortcat to `Xquery::Generic.with`
-
-  ```
-  r = XQuery(''.html_safe) do |q|
-    # similar to tap
-    q << 'bla bla bla'
-    q << 'bla bla bla'
-    # using truncate
-    q.truncate(15)
-    # real content (q.send(:query)) mutated
-    q << '!'
-  end
-  r # => "bla bla blab...!"
-  ```
-  ## Usage of `XQuery::Abstract`
-  I designed this gem to help me with `ActiveRecord` Queries, so i inherited
-  `XQuery::Abstract` and used it's powers. It provides the following features
-  ### `wrap_method` and `wrap_methods`
-  when you call each of this methods they became automatically wrapped
-  (`XQuery::Abstract` basically wraps all methods query `#respond_to?`)
-  It means, that there are instance methods with same name defined and will
-  change a `#query` to their call result.
-  ```
-  self.query = query.foo(x)
-  # is basically the same as
-  foo(x)
-  # when `wrap_method :foo` called
-  ```
-
-  You can also specify new name using `wrap_method :foo, as: :bar` syntax
-  ### `q` object
-  `q` is a proxy object which holds all of wrapped methods,
-  but not methods you defined inside your class.
-  E.g. i have defined `wrap_method(:foo)`, but also delegated `#foo` to some
-  another object. If i call `q.foo`, i will get wrapped method.
-  Note, that if you redefine `#__foo` method, q.foo will call it instead of
-  normal work.
-  You can add additional methods to `q` using something like `alias_on_q :foo`.
-  I used it with `kaminary` and it was useful
-  ```
-  def page=(x)
-    apply { |query| query.page(x) }
-  end
-  alias_on_q :page=
-
-  def page
-    query.current_page
-  end
-  alias_on_q :page
-  ```
-
-  ### `query_superclass`
-  You should specify `query_superclass` class_attribute to inherit
-  `XQuery::Abstract`. Whenever `query.is_a?(query_superclass)` evaluate to false,
-  you will get `XQuery::QuerySuperclassChanged` exception.
-  It can save you much time when your class misconfigured.
-  E.g. you are using `select!` and it returns `nil`, because why not?
-
-  ### `#apply` method
-  `#apply` does exact what it source tells
-  ```
-  # yields query inside block
-  # @param block [#to_proc]
-  # @return [XQuery::Abstract] self
-  def apply(&block)
-    self.query = block.call(query)
-    self
-  end
-  ```
-  It is usefull to merge different queries.
-
-  ### `with` class method
-  You can get XQuery functionality even you have not defined a specific class
-  (You are still have to inherit XQuery::Abstract to use it)
-  You can see it in this document when i described `XQuery` function.
-  Note, that it yields a class instance, not `q` object.
-  It accepts any arguments, they will be passed to a constructor (except block)
-  If you want only to call one function on an instance (e.g. `#apply`),
-  you should prefer `execute` alias
+        version: 2.4.3
+description: "# XQuery\n\n[![Join the chat at https://gitter.im/JelF/xquery](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JelF/xquery?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[![Build
+  Status](https://travis-ci.org/JelF/xquery.svg?branch=master)](https://travis-ci.org/JelF/xquery)\n[![Code
+  Climate](https://codeclimate.com/github/JelF/xquery/badges/gpa.svg)](https://codeclimate.com/github/JelF/xquery)\n[![Test
+  Coverage](https://codeclimate.com/github/JelF/xquery/badges/coverage.svg)](https://codeclimate.com/github/JelF/xquery/coverage)\n[![Issue
+  Count](https://codeclimate.com/github/JelF/xquery/badges/issue_count.svg)](https://codeclimate.com/github/JelF/xquery)
+  \ \nXQuery is designed to replace boring method call chains and allow to easier\nconvert
+  it in a builder classes\n## Usage of `XQuery` function\n`XQuery` is a shortcat to
+  `XQuery::Generic.with`\n\n```\nr = XQuery(''.html_safe) do |q|\n  # similar to tap\n
+  \ q << 'bla bla bla'\n  q << 'bla bla bla'\n  # using truncate\n  q.truncate(15)\n
+  \ # real content (q.send(:query)) mutated\n  q << '!'\nend\nr # => \"bla bla blab...!\"\n```\n##
+  Usage of `XQuery::Abstract`\nI designed this gem to help me with `ActiveRecord`
+  Queries, so i inherited\n`XQuery::Abstract` and used it's powers. It provides the
+  following features\n### `wrap_method` and `wrap_methods`\nwhen you call each of
+  this methods they became automatically wrapped\n(`XQuery::Abstract` basically wraps
+  all methods query `#respond_to?`)\nIt means, that there are instance methods with
+  same name defined and will\nchange a `#query` to their call result.\n```\nself.query
+  = query.foo(x)\n# is basically the same as\nfoo(x)\n# when `wrap_method :foo` called\n```\n\nYou
+  can also specify new name using `wrap_method :foo, as: :bar` syntax\n### `q` object\n`q`
+  is a proxy object which holds all of wrapped methods,\nbut not methods you defined
+  inside your class.\nE.g. i have defined `wrap_method(:foo)`, but also delegated
+  `#foo` to some\nanother object. If i call `q.foo`, i will get wrapped method.\nNote,
+  that if you redefine `#__foo` method, q.foo will call it instead of\nnormal work.\nYou
+  can add additional methods to `q` using something like `alias_on_q :foo`.\nI used
+  it with `kaminary` and it was useful\n```\ndef page=(x)\n  apply { |query| query.page(x)
+  }\nend\nalias_on_q :page=\n\ndef page\n  query.current_page\nend\nalias_on_q :page\n```\n\n###
+  `query_superclass`\nYou should specify `query_superclass` class_attribute to inherit\n`XQuery::Abstract`.
+  Whenever `query.is_a?(query_superclass)` evaluate to false,\nyou will get `XQuery::QuerySuperclassChanged`
+  exception.\nIt can save you much time when your class misconfigured.\nE.g. you are
+  using `select!` and it returns `nil`, because why not?\n\n### `#apply` method\n`#apply`
+  does exact what it source tells\n```\n# yields query inside block\n# @param block
+  [#to_proc]\n# @return [XQuery::Abstract] self\ndef apply(&block)\n  self.query =
+  block.call(query)\n  self\nend\n```\nIt is usefull to merge different queries.\n\n###
+  `with` class method\nYou can get XQuery functionality even you have not defined
+  a specific class\n(You are still have to inherit XQuery::Abstract to use it)\nYou
+  can see it in this document when i described `XQuery` function.\nNote, that it yields
+  a class instance, not `q` object.\nIt accepts any arguments, they will be passed
+  to a constructor (except block)\n\n### `execute` method\nPreferred way to call public
+  instance methods.\nResulting query would be returned\n"
 email:
 - begdory4+xquery@gmail.com
 executables: []
@@ -239,10 +206,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: XQuery is designed to replace boring method call chains and allow to easier
   convert it in a builder classes see README.md for more information
 test_files: []
-has_rdoc: