sqlcached_client 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ca1306befc4783825e8041edfad314f1d1cae0
-  data.tar.gz: af0ed719bd8e6f8739a4e48590c559eef771dd54
+  metadata.gz: b748c4321404ba53adfea1f54149b8940e639b3e
+  data.tar.gz: 1aa280da099b3775b1f1573f3ff1f1a22d9db614
 SHA512:
-  metadata.gz: e7b476e0945653b5b1c494876520d7b4424c156583575a1e53bbf519604f3e846bde5ea580a24dba93894b874044d6659b219856b703dab6e4fed5e9d00bedd3
-  data.tar.gz: f94bfea52a4113c3a50adf986c6f843f1f7663d9f3760f19b73ef6707b69abbbdc592c9df93ca99f4d1e62718c4bf181fd1a563b0addd2481b07d59b6af359a7
+  metadata.gz: d19236cb3ede1bde65802ea4d6453bd4624a16c5d629a1bb91f65b59273701e9de81c66245ed947d40e86188ee43c9482c5f61ef397b7c9cb01786bcb316aed6
+  data.tar.gz: a12f68121d759e630c16873967b7413d1c2b5135e556a33dd49f366c365a4f0ac12663682dc86757c805b7c0dd161309d923416e5a628228ec9a425b1ea0dbc1

data/lib/sqlcached_client/entity.rb

@@ -18,13 +18,33 @@ module SqlcachedClient
 
 
     class << self
-      attr_reader :query_id
+
+      # Sets a prefix for each entity name, or returns the value previously set
+      # if no parameter is given
+      def entity_namespace(value = nil)
+        if value.nil?
+          @entity_namespace || try_ancestor(:entity_namespace)
+        else
+          @entity_namespace = value
+        end
+      end
 
       # Sets the name of this entity
+      # @param value [String]
       def entity_name(value)
         @query_id = value
       end
 
+      # Returns the identifier of the query template of the current entity
+      # @return [String]
+      def query_id
+        if prefix = entity_namespace.presence
+          "#{prefix}::#{@query_id}"
+        else
+          @query_id
+        end
+      end
+
       # Sets the query of this entity if a parameter is provided, otherwise
       # returns the value previously set.
       def query(*args, &block)
@@ -49,12 +69,7 @@ module SqlcachedClient
       # otherwise returns the server object previously set.
       def server(config = nil)
         if config.nil?
-          @server ||
-            if superclass = ancestors[1..-1].detect { |a| a.respond_to?(:server) }
-              superclass.server
-            else
-              nil
-            end
+          @server || try_ancestor(:server)
         else
           @server =
             if config.is_a?(Hash)
@@ -193,7 +208,7 @@ module SqlcachedClient
       def cache(seconds = nil)
         if seconds.nil?
           @cache ||
-            if superclass = ancestors[1..-1].detect { |a| a.respond_to?(:cache) }
+            if superclass = ancestors_lookup(:cache)
               superclass.cache
             else
               true
@@ -275,6 +290,22 @@ module SqlcachedClient
         @registered_associations ||= []
         @registered_associations << association_struct
       end
+
+      # Finds the first ancestor that responds to the given method
+      # @param method_name [Symbol] the method to find
+      # @return [Class]
+      def ancestors_lookup(method_name)
+        ancestors[1..-1].detect { |a| a.respond_to?(method_name) }
+      end
+
+      # Calls the given method on the first ancestor that responds to the
+      # method
+      # @param method_name [Symbol]
+      # @return nil if no ancestor responds to the method, or the value
+      #   returned by 'method_name'
+      def try_ancestor(method_name)
+        ancestors_lookup(method_name).try(method_name)
+      end
     end # class << self
 
     # Define the readers for the attribute names specified

data/lib/sqlcached_client/version.rb

@@ -1,3 +1,3 @@
 module SqlcachedClient
-  VERSION = "0.2.3"
+  VERSION = "1.0.0"
 end

data/spec/sqlcached_client/entity_spec.rb

@@ -29,6 +29,27 @@ describe SqlcachedClient::Entity do
   end
 
 
+  describe :entity_namespace do
+    context "if a parameter is provided" do
+      it "sets @entity_namespace" do
+        entity_class = Class.new(SqlcachedClient::Entity) do
+          entity_namespace("foo")
+        end
+        expect(entity_class.instance_variable_get(:@entity_namespace)).to eq("foo")
+      end
+    end
+
+    context "if no parameter is given" do
+      it "returns the value previously set" do
+        entity_class = Class.new(SqlcachedClient::Entity) do
+          entity_namespace("foo")
+        end
+        expect(entity_class.entity_namespace).to eq("foo")
+      end
+    end
+  end
+
+
   describe :query do
     context "if a parameter is provided" do
       it "should set @query and strip spaces" do
@@ -50,6 +71,28 @@ describe SqlcachedClient::Entity do
   end
 
 
+  describe :query_id do
+    context "if an entity_namespace was set" do
+      it "is entity_namespace::entity_name" do
+        entity_class = Class.new(SqlcachedClient::Entity) do
+          entity_namespace("foo")
+          entity_name("bar")
+        end
+        expect(entity_class.query_id).to eq("foo::bar")
+      end
+    end
+
+    context "if no entity_namespace was set" do
+      it "is entity_name" do
+        entity_class = Class.new(SqlcachedClient::Entity) do
+          entity_name("bar")
+        end
+        expect(entity_class.query_id).to eq("bar")
+      end
+    end
+  end
+
+
   describe :server do
     context "if a parameter is provided" do
       it "should set @server" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqlcached_client
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Roberto Maestroni