xquery 0.1.3-java → 0.2.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33e6fdb5a289ea9dd885be6ecb0abe3ce0db6829
-  data.tar.gz: d7759edc915b5c87dfe1ddbe92699e4fa4ba7f0a
+  metadata.gz: 7805222ef90fd9a6a76f3c4cd21783e438a026d0
+  data.tar.gz: c2bcff3ecf1a549f62a32cdfa9270aac3f4f03f7
 SHA512:
-  metadata.gz: b6e8ad5cba36841f9eab41f4c1c4f5d21481296958ed44a6f69adbe54f010e74ac22f9d6fef5d9f64ac3f8b25f876035f305cf379526fdac252cbf37b5906b17
-  data.tar.gz: ad988f2174be9ad81271da984ab14591ba6ad542421324cfb1cab68f556dfcba3232130ce0e86c6df248b7a03fc9f5090bcc3e54f35013d960e34020c0e3f30a
+  metadata.gz: b7fc897c36eec97a269b8502a9664a776347c1cdea2c5a64b429683fd87e0f7725927e456ba3eca4d53aadb6ba6319ccbda523c3a14cbd154d25d5a98ca6ef86
+  data.tar.gz: bb8e5ef86fc5cd94ce53415fe3c8fbd86263bed4e2363a754491619860a261de9bd399e1779dd6e136244567d7ddd2dabdcb60c6d62ccfb0b95751c24c916d88

data/lib/xquery/abstract.rb

@@ -4,11 +4,11 @@ require 'xquery/query_proxy'
 require 'xquery/errors'
 
 module XQuery
-  # abstract superclass, should be inherited, not used
+  # Abstract superclass, should be inherited, not used
   class Abstract
     class_attribute :query_superclass
 
-    # yields instance inside block. I suggest to name it `q`
+    # 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)
@@ -17,10 +17,6 @@ module XQuery
       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
@@ -30,13 +26,13 @@ module XQuery
       alias_on_q(as, true)
     end
 
-    # same as wrap_method, but hanldes multiply methods
+    # Aame 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
+    # 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)
@@ -68,7 +64,27 @@ module XQuery
       @query_proxy = self.class.query_proxy.new(self)
     end
 
-    # yields query inside block
+    # Yields iteself inside block. I suggest to name it `q`
+    # @param block [#to_proc] block to whitch instance would be yielded
+    # @return [Object] query
+    def with(&block)
+      block.call(self)
+      query
+    end
+
+    # Executes specified method, returns query.
+    # Feel free to redefine this method in case it's only public api method
+    # in your class
+    # @param method [#to_sym] any instance public method name
+    # @param args [Array(Object)] method call params
+    # @param block [#to_proc] block would be sent to method
+    # @return [Object] query
+    def execute(method, *args, &block)
+      public_send(method, *args, &block)
+      query
+    end
+
+    # Yields query inside block
     # @param block [#to_proc]
     # @return [XQuery::Abstract] self
     def apply(&block)
@@ -78,14 +94,14 @@ module XQuery
 
     private
 
-    # @private_api
-    # updates query by calling method on it and storing the result
+    # 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
+    # Added constraints check
     # @raise XQuery::QuerySuperclassChanged
     def query=(x)
       unless x.is_a?(query_superclass)

data/lib/xquery/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xquery
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: java
 authors:
 - jelf