xquery 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca2ea723ba64628698695acc969bd8f60c172855
-  data.tar.gz: 352dabe6be5a151d95f0b441f5db8284e74e295d
+  metadata.gz: 1b2ebbc8254056710b841ed9b8ad053fcd8884d8
+  data.tar.gz: 49b26a7409bbf2f897fcd70ae67de9635cb938e2
 SHA512:
-  metadata.gz: 5f728b160b85f0a1705374648e9f106a99e376673f79a4157996864be0896c40d5d5a98e9e786f9bfda54f0378e61104ce1a24efb44e0835ece0909c50c96831
-  data.tar.gz: a05b0d370bbab41f684455d4d28569ada79a0660a92de8f57f544495ecc72eb587c173e3749d7a8ebd5c0ea0da0f682c420dac9baf09b6491eefd0167870f48e
+  metadata.gz: 4c2a9116c4bf2e4f1ffbd8c093cb0cb3fbb01f46c7fd9adc244a15fd8cbb6c64f18a19a1e23f74331ee287c94b134712446951ba4ca5f71b6d4dac82d70d11e6
+  data.tar.gz: fee367d59345833fe0cc4d77c01a35480b6da979c3e3d293b4e653d0f7b86adc590bce7626b2e8e3448738a5f2fadfac3fc2dfa36d8c779a0dc2c499d6c2b394

data/home/jelf/docs/xquery/lib/xquery.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+
+# 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
+module XQuery
+end
+
+require 'xquery/version'
+require 'xquery/generic'

data/home/jelf/docs/xquery/lib/xquery/abstract.rb

@@ -0,0 +1,104 @@
+require 'active_support/core_ext/class/attribute.rb'
+
+require 'xquery/query_proxy'
+require 'xquery/errors'
+
+module XQuery
+  # abstract superclass, should be inherited, not used
+  class Abstract
+    class_attribute :query_superclass
+
+    # 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
+    end
+
+    class << self
+      alias_method :execute, :with
+    end
+
+    # Defines `method`, `__method` and `q.method`.
+    # Both of wich changes query to query.method
+    # @param name [#to_sym] name of method on query
+    # @param 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)
+    end
+
+    # same as wrap_method, but hanldes multiply methods
+    # @param methods [Array(#to_sym)] names of methods defined
+    def self.wrap_methods(*methods)
+      methods.each(&method(:wrap_method))
+    end
+
+    # Aliases method to __method and q.method
+    # @param name [#to_sym] name of method
+    # @param return_self [Boolean] should defined method return self or result
+    def self.alias_on_q(name, return_self = false)
+      alias_method("__#{name}", name)
+      private("__#{name}")
+
+      query_proxy.send(:define_method, name) do |*args, &block|
+        result = instance.send("__#{name}", *args, &block)
+        return_self ? self : result
+      end
+    end
+
+    # @return [Class] query_proxy (`q`) class
+    def self.query_proxy
+      @query_proxy ||= Class.new(QueryProxy)
+    end
+
+    # inherited classes should also have their query_proxies inherited
+    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
+      @query_proxy = self.class.query_proxy.new(self)
+    end
+
+    # yields query inside block
+    # @param block [#to_proc]
+    # @return [XQuery::Abstract] self
+    def apply(&block)
+      self.query = block.call(query)
+      self
+    end
+
+    private
+
+    # @private_api
+    # updates query by calling method on it and storing the result
+    # @return [XQuery::Abstract] self
+    def _update_query(method, *args, &block)
+      apply { |x| x.public_send(method, *args, &block) }
+    end
+
+    # added constraints check
+    # @raise XQuery::QuerySuperclassChanged
+    def query=(x)
+      unless x.is_a?(query_superclass)
+        fail QuerySuperclassChanged.new(x, query_superclass)
+      end
+
+      @query = x
+    end
+
+    # @return [XQuery::QueryProxy] object could be used
+    #   to access method wrappers unchanged
+    def q
+      @query_proxy
+    end
+  end
+end

data/home/jelf/docs/xquery/lib/xquery/errors.rb

@@ -0,0 +1,18 @@
+module XQuery
+  # raised when superclass of query changed
+  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
+    # @param expectation [Class] expected superclass
+    def initialize(result, expectation)
+      @result = result
+      @expectation = expectation
+      super("Expected #{result.inspect} to be an instance of #{expectation}")
+    end
+  end
+end

data/home/jelf/docs/xquery/lib/xquery/generic.rb

@@ -0,0 +1,35 @@
+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)
+      super unless respond_to_missing?(name)
+      _update_query(name, *args, &block)
+    end
+
+    # respond to all public model methods
+    def respond_to_missing?(name, *)
+      query.respond_to?(name, true)
+    end
+
+    private
+
+    # q object refers to self, not proxy
+    def q
+      self
+    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/home/jelf/docs/xquery/lib/xquery/query_proxy.rb

@@ -0,0 +1,15 @@
+module XQuery
+  # This proxy can be used to access raw wrappers inside classes,
+  # inherited from XQuery::Abstract
+  class QueryProxy
+    # @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/home/jelf/docs/xquery/lib/xquery/version.rb

@@ -0,0 +1,4 @@
+module XQuery
+  # defines XQuery version
+  VERSION = '0.1.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xquery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - jelf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,6 +112,7 @@ 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`
 
@@ -197,7 +198,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- "/home/jelf/docs/xquery/lib/xquery.rb"
+- "/home/jelf/docs/xquery/lib/xquery/abstract.rb"
+- "/home/jelf/docs/xquery/lib/xquery/errors.rb"
+- "/home/jelf/docs/xquery/lib/xquery/generic.rb"
+- "/home/jelf/docs/xquery/lib/xquery/query_proxy.rb"
+- "/home/jelf/docs/xquery/lib/xquery/version.rb"
 homepage: https://github.com/JelF/xquery
 licenses:
 - WTFPL