kaicho 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b149a80108fa8af5935e0f99b59b90b2f969b4d386b14178b6eb90db506e5b4
-  data.tar.gz: 71a2d0c27a52c307b5593f69cb7a3922a3c9610a9772ba4ff5e21cba7c2eb3e3
+  metadata.gz: 10295f3c7c5a763d97c7f2e611c1f63766a6250d937e1295881031fecda0d08e
+  data.tar.gz: bf5e3bd28fbd09324a6944cdb09035d5c83bdfae97a4abefac3715255b302527
 SHA512:
-  metadata.gz: 6b0880aefc00222a7111195111ddf4924f5010ec5ca406c5420d399848d9e89a4f6cb2dab42b3296304423c567c8946cea28dafa3f8766709b7ac9a35823536e
-  data.tar.gz: 3342fc356fc06c54720d66ae236de47e77e2a300d919a97940c881c51ec72400650f42591f2ab84a7484024c8d6aff5a9a1ffecbc715dce998d316e9f2c0e84b
+  metadata.gz: 275467c78b00d15d69d4b614e62080ac40bae1fe11b3513464856f7c06e9fa6a4c01f2e2c372fdc5893a24f39f7abe2bbbeb3633a881a9ea6bb869cd59a23b28
+  data.tar.gz: eb7a56313adcb19c7fe8faebb5590795231c188bb2e8e89cade8d3417467bc1ac1dd68cc1684f45e310e6396f7234b85a7885801ebabf2cf3763a456a2907df3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kaicho (0.1.0)
+    kaicho (0.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -15,14 +15,14 @@ GEM
     diff-lcs (1.3)
     docile (1.3.1)
     json (2.1.0)
-    rake (12.3.1)
+    rake (12.3.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -34,10 +34,10 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.6.0)
+    term-ansicolor (1.7.0)
       tins (~> 1.0)
     thor (0.19.4)
-    tins (1.16.3)
+    tins (1.20.2)
 
 PLATFORMS
   ruby
@@ -50,4 +50,4 @@ DEPENDENCIES
   rspec (~> 3.8, >= 3.8.0)
 
 BUNDLED WITH
-   1.16.5
+   1.17.1

data/lib/kaicho.rb

@@ -15,6 +15,35 @@ require 'kaicho/util'
 #
 # Note that all methods act on instances of Classes at the moment.
 module Kaicho
+  # Called when Kaicho is `include`d
+  # if you use the provided class methods, be sure to call super in your
+  # initialize method, otherwise they will have no effect
+  def self.append_features(rcvr)
+    super
+
+    rcvr.instance_variable_set(:@class_resources, [])
+    rcvr.instance_variable_set(:@class_triggers, [])
+
+    # @see #def_resource
+    rcvr.define_singleton_method(:def_resource) do |*args, &block|
+      @class_resources << [args, block]
+    end
+
+    # @see #add_triggers
+    rcvr.define_singleton_method(:add_triggers) do |*triggers|
+      @triggers += triggers
+    end
+  end
+
+  def initialize
+    (self.class.instance_variable_get(:@class_resources))
+      .each { |args, block| def_resource(*args, &block) }
+
+    add_triggers(*(self.class.instance_variable_get(:@class_triggers)))
+
+    super
+  end
+
   # adds trigger(s) which can be used to trigger updates of resources
   # who have the trigger set
   #
@@ -64,7 +93,7 @@ module Kaicho
       end
 
     define_singleton_method(dname) do
-      update_resource(dname) unless @resources[dname][:udid].positive?
+      update_resource(dname, rand) unless resource_defined?(dname)
       read.call
     end
 
@@ -90,7 +119,7 @@ module Kaicho
 
     define_singleton_method(:"#{dname}=") do |v|
       write.call(v)
-      update_dependants(dname)
+      update_dependants(dname, rand)
       v
     end
 
@@ -121,6 +150,7 @@ module Kaicho
   #   - +:write+, +:w+  - defines an {#attr_writer}
   #   - +:both+,  +:rw+ - defines both, see {#attr_accessor}
   #   - +:none+         - don't generate any accessors
+  # @param [Symbol] accessors alias to accessor
   # @param block a block that will be called, with no arguments, to update this
   #   resource
   # @return [True] this method always returns true or raises an exception
@@ -128,15 +158,20 @@ module Kaicho
                    depends:   {},
                    triggers:  [],
                    overwrite: false,
-                   share:    nil,
-                   accessor: :read,
+                   share:     nil,
+                   accessor:  :read,
+                   accessors: nil,
                    &block)
     @resources ||= {}
 
+    accessor = accessors unless accessors.nil?
+
     Kaicho::Util.check_type(Symbol, dname)
     Kaicho::Util.check_type(Hash, depends)
     Kaicho::Util.check_type(Array, triggers)
 
+    block = nil unless block_given?
+
     unless %i[read r write w both rw none].include?(accessor)
       raise(ArgumentError, "invalid accessor: :#{accessor}")
     end
@@ -208,23 +243,23 @@ module Kaicho
     end
 
     return if @resources[dname][:udid] == udid
-
     udid ||= rand
+    @resources[dname][:udid] = udid
 
     return unless update_depends(dname, udid)
 
-    result = @resources[dname][:proc].call
+    unless @resources[dname][:proc].nil?
+      result = self.instance_exec(&@resources[dname][:proc])
 
-    if @resources[dname][:share].nil?
-      instance_variable_set(@resources[dname][:varname], result)
-    else
-      @resources[dname][:share].class_variable_set(
-        @resources[dname][:varname], result
-      )
+      if @resources[dname][:share].nil?
+        instance_variable_set(@resources[dname][:varname], result)
+      else
+        @resources[dname][:share].class_variable_set(
+          @resources[dname][:varname], result
+        )
+      end
     end
 
-    @resources[dname][:udid] = udid
-
     update_dependants(dname, udid)
 
     true
@@ -237,7 +272,7 @@ module Kaicho
   # @param dname the name of the resource
   # @param udid the update-id of this call, this should be left +nil+.  It is
   #   internally to avoid infinite loops during update cascades.
-  # @return [True] this method always returns true or raises an exception
+  # @return [bool] returns false if the resource could not be found, else return true
   def update_depends(dname, udid = nil)
     udid ||= rand
     @resources[dname][:depends].each do |d, o|
@@ -265,10 +300,9 @@ module Kaicho
   # @return [True] this method always returns true or raises an exception
   def update_dependants(dname, udid = nil)
     udid ||= rand
-    dependants = @resources.select do |_, v|
+    @resources.select do |_, v|
       v[:depends].include?(dname) && v[:udid] != udid
-    end
-    dependants.each { |d, _| update_resource(d, udid) }
+    end.each { |d, _| update_resource(d, udid) }
 
     true
   end
@@ -295,8 +329,23 @@ module Kaicho
   # @return [True] this method always returns true or raises an exception
   def update_all_resources
     udid = rand
-    @resources.keys.each { |d| update_resource(d, udid) }
+
+    resource_roots.each { |d| update_resource(d, udid) }
 
     true
   end
+
+  # Determine the root resources of the current object
+  #
+  # A resource is a root resource if it either does not depend on anything or
+  # all of its dependencies have the +:fail+ action (i.e. they are not managed
+  # by kaicho)
+  #
+  # @return [Array] an array of Symbol where each element is the name of a
+  #   resource root
+  def resource_roots
+    @resources.select do |a, attr|
+      attr[:depends].empty? || attr[:depends].all? { |_,a| a == :fail }
+    end.map { |a, _| a  }
+  end
 end

data/lib/kaicho/version.rb

@@ -2,5 +2,5 @@
 
 module Kaicho
   # Version of Kaicho
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaicho
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Stone Tickle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler