xquery 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7656940fa572468cfb4ebc256618272f2ec5bac
-  data.tar.gz: 1eefdf1dc536d6e02a7931fd42515ebb91e0bcd1
+  metadata.gz: b1e4c4058ba8d6f621da2a420773cd6b6578c899
+  data.tar.gz: 617512ed3fa56d31783c79e6c1dd87cf990a64be
 SHA512:
-  metadata.gz: b28e7c6dc0334204ba1bda28a7a027a6d1c9b5037bbcc95123b21d3d476c88227f6d8373186641d8bc20b7b96827e92c348a7139fd5d13d6d0a95ea178d34280
-  data.tar.gz: 7f2f834c00a79fd9eb0c2eaa97da21f5bb59c7b63c305bec07868751b17d120fa43597221ce246f75010966233a009c664188b79cf6e03f67f37cdc6a20bdb62
+  metadata.gz: 1fac614b682fe0b4673aafa5c9acd189ad4fa2a90da997244c427cf728fa62a24c781fb49b6bfca8666e9a2061bbb216ea8abc00a9b2593f707ccb0f675c5408
+  data.tar.gz: 0fee5220b9fb5111e27a75979af3b7d40028f636ec31176a0bbca5bf8858ba1dc10af3edfe052a68be898a0f6c9ca05778bd1a8d58b712666ca41adf2120bee3

data/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/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/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/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/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/lib/xquery/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xquery
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - jelf
@@ -198,7 +198,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/xquery.rb
+- lib/xquery/abstract.rb
+- lib/xquery/errors.rb
+- lib/xquery/generic.rb
+- lib/xquery/query_proxy.rb
+- lib/xquery/version.rb
 homepage: https://github.com/JelF/xquery
 licenses:
 - WTFPL