xquery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca2ea723ba64628698695acc969bd8f60c172855
+  data.tar.gz: 352dabe6be5a151d95f0b441f5db8284e74e295d
+SHA512:
+  metadata.gz: 5f728b160b85f0a1705374648e9f106a99e376673f79a4157996864be0896c40d5d5a98e9e786f9bfda54f0378e61104ce1a24efb44e0835ece0909c50c96831
+  data.tar.gz: a05b0d370bbab41f684455d4d28569ada79a0660a92de8f57f544495ecc72eb587c173e3749d7a8ebd5c0ea0da0f682c420dac9baf09b6491eefd0167870f48e

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: xquery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jelf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 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
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |
+  # XQuery
+  XQuery is designed to replace boring method call chains and allow to easier
+  convert it in a builder classes
+  ## 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
+email:
+- begdory4+xquery@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files: []
+homepage: https://github.com/JelF/xquery
+licenses:
+- WTFPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.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: