kaicho 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb83b5885137a7bf2c5f7356781218603fff10efd4ff45f2d3279ba9e9df9c03
+  data.tar.gz: a16eb9fb31003ce0030e3520d7825a34e76d27f3bc68ef481f1b705d894e1ce9
+SHA512:
+  metadata.gz: 16b18fd50f9585ca9654244efbf784f45d250f3bad1e915a97631d84ad43c2f2da29ec5ca5aea414997db4187d3cc1e886dddb46d62785a4ec8b994680eaaaac
+  data.tar.gz: ccf475fcdceda0ffd6b15ee90d30ea06d8db64d059a6f6be6e1b8b665c1dec9ff1b56d5ab1d815e92272f87bc26bd72bf7a6b591ce010407d9a8f3c061d92fb8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kaicho.gemspec
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+# Kaicho
+
+Kaicho is the boss for your resources.  It handles keeping everything up to
+date.
+
+```ruby
+class Fruits
+  include Kaicho
+
+  def intialize
+    def_resource :apples, accessor: :both { @apples || 0 }
+    def_resource :oranges, accessor: :both { @oranges || 0 }
+    def_resource :total, depend: { apples: :fail, oranges: :fail } do
+      puts "computing total"
+      @apples + @oranges
+    end
+  end
+end
+
+f = Fruits.new
+f.apples         #=> 0
+f.apples += 1    #=> 1
+computing total
+f.oranges = 10   #=> 10
+computing total
+f.total          #=> 11
+f.oranges = 2
+computing total
+f.total          #=> 13
+f.total          #=> 13
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kaicho"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kaicho.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kaicho/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kaicho"
+  spec.version       = Kaicho::VERSION
+  spec.authors       = ["Stone Tickle"]
+  spec.email         = ["lattis@mochiro.moe"]
+
+  spec.summary       = "a resource manager"
+  spec.homepage      = "https://github.com/annacrombie/kaicho"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kaicho.rb

@@ -0,0 +1,230 @@
+require "kaicho/version"
+
+# Kaicho is a module that assists in a class's resource management.
+# It enables you to chain resources together.  Each resource when changed
+# will update all of its dependants.  Additionally, if you try to access a
+# resource which has not been initialized, it will update itself along with
+# all resources it depends on.
+#
+# This is useful if you have a class with many instance variables that all
+# form a dependancy tree.  For instance:
+#
+# ```
+# class Fruits
+#   include Kaicho
+#
+#   def intialize
+#     def_resource :apples, accessor: :both { @apples || 0 }
+#     def_resource :oranges, accessor: :both { @oranges || 0 }
+#     def_resource :total, depend: { apples: :fail, oranges: :fail } do
+#       puts "computing total"
+#       @apples + @oranges
+#     end
+#   end
+# end
+#
+# f = Fruits.new
+# f.apples         #=> 0
+# f.apples += 1    #=> 1
+# computing total
+# f.oranges = 10   #=> 10
+# computing total
+# f.total          #=> 11
+# f.oranges = 2
+# computing total
+# f.total          #=> 13
+# f.total          #=> 13
+# ```
+module Kaicho
+  # adds trigger(s) which can be used to trigger updates of resources
+  # who have the trigger set
+  #
+  # @param t a list of symbols to be used as triggers
+  def add_triggers(*t)
+    @triggers ||= []
+    @triggers += t.map(&:to_sym)
+  end
+
+  # makes both an attr_reader and an attr_writer for the `dname`
+  #
+  # @param dname the resource to create accessors for
+  # @param share the owner of the shared variable
+  def attr_accessor(dname, share: nil)
+    attr_reader(dname, share: nil)
+    attr_writer(dname, share: nil)
+  end
+
+  # builds an attr_reader for a resource which functions just like a typical
+  # attr_reader but will update the resource if it hasn't been accessed
+  # before.
+  #
+  # @param dname the resource that will be accessed
+  # @param share the owner of the shared variable
+  def attr_reader(dname, share: nil)
+    read = share.nil? ? -> { instance_variable_get(:"@#{dname}") }
+                      : -> { share.class_variable_get(:"@@#{dname}") }
+    define_singleton_method(dname) do
+      update_resource(dname) unless @resources[dname][:udid].positive?
+      read.call
+    end
+  end
+
+  # builds an attr_writer for a resource which functions just like a typical
+  # attr_writer but will update the resource's dependants when it is called.
+  #
+  # @param dname the resource that will be accessed
+  # @param share the owner of the shared variable
+  def attr_writer(dname, share: nil)
+    write = share.nil? ? -> (v) { instance_variable_set(:"@#{dname}", v) }
+                       : -> (v) { share.class_variable_set(:"@@#{dname}", v) }
+    define_singleton_method(:"#{dname}=") do |v|
+      write.call(v)
+      update_dependants(dname)
+      v
+    end
+  end
+
+  def check_type(expected, got)
+    unless expected === got
+      raise TypeError.new("expected #{expected.name} got #{got}:#{got.class.name}")
+    end
+  end
+
+  # define a resource
+  #
+  # @param dname the name of the resource
+  # @param depends a hash of dependants with the format
+  #                { dependant_name: :update_action }
+  #                where update_action is the action that
+  #                is taken when this resource is updated.
+  #                update_action can be one of
+  #                :
+  def def_resource(dname,
+                   depends:   {},
+                   triggers:  [],
+                   overwrite: false,
+                   share:    nil,
+                   accessor: :read,
+                   &block)
+    @resources ||= {}
+
+    check_type(Symbol, dname)
+    check_type(Hash, depends)
+    check_type(Array, triggers)
+
+    return if @resources.key?(dname) && !overwrite
+
+    add_triggers # initialize @triggers to []
+    triggers.each do |t|
+      raise ArgumentError.new("invalid trigger ':#{t}'") unless @triggers.include?(t)
+    end
+
+    depends.map =
+      case depends
+      when Array
+        depends.map { |d| [d, :keep] }.to_h
+      when Hash
+        depends
+      else
+        { depends => :keep }
+      end
+
+    Zashoku.log.warn(self) { "overwriting resource #{dname}" } if @resources.key?(dname)
+    Zashoku.log.info(self) { "defining resource #{dname}" }
+    @resources.merge!(
+      dname => {
+        depends:  depends,
+        proc:     block,
+        udid:     -1,
+        triggers: triggers & (@triggers || []),
+        share:    share,
+        varname:  share.nil? ? "@#{dname}" : "@@#{dname}"
+      }
+    )
+
+    case accessor
+    when :read,  :r
+      attr_reader(dname, share: share)
+    when :write, :w
+      attr_writer(dname, share: share)
+    when :both,  :rw
+      attr_accessor(dname, share: share)
+    end
+  end
+
+  def resource_defined?(dname)
+    return instance_variable_defined?("@#{dname}") unless @resources.key?(dname)
+
+    if @resources[dname][:share].nil?
+      instance_variable_defined?(@resources[dname][:varname])
+    else
+      @resources[dname][:share].class_variable_defined?(@resources[dname][:varname])
+    end
+  end
+
+  def update_resource(dname, udid=nil)
+    raise "no such resource #{dname}" unless @resources.key?(dname)
+
+    Zashoku.log.debug(self) { "not updating #{dname}" } if @resources[dname][:udid] == udid
+
+    return if @resources[dname][:udid] == udid
+
+    Zashoku.log.debug(self) { "updating resource #{dname} #{udid}" }
+
+    udid ||= rand
+
+    return unless update_requisites(dname, udid)
+
+    result = @resources[dname][:proc].call
+
+    if @resources[dname][:share].nil?
+      instance_variable_set(@resources[dname][:varname], result)
+    else
+      @resources[dname][:share].class_variable_set(@resources[dname][:varname], result)
+    end
+
+    @resources[dname][:udid] = udid
+
+    update_dependants(dname, udid)
+  end
+
+  def update_requisites(dname, udid=nil)
+    udid ||= rand
+    @resources[dname][:depends].each do |d, o|
+      case o
+      when :update
+        update_resource(d, udid)
+      when :keep
+        update_resource(d, udid) unless resource_defined?(d)
+      when :fail
+        unless resource_defined?(d)
+          Zashoku.log.debug(self) { "update resource #{dname} failing on #{d}" }
+          return false
+        end
+      when :force
+        update_resource(d, udid)
+      else
+        raise "option #{o} not understood for #{d} while updating #{dname}"
+      end
+      true
+    end
+  end
+
+  def update_dependants(dname, udid=nil)
+    udid ||= rand
+    Zashoku.log.debug(self) { "updating dependants for #{dname}" }
+    dependants = @resources.select { |_,v| v[:depends].include?(dname) && v[:udid] != udid }
+    dependants.each { |d,_| update_resource(d, udid) }
+  end
+
+  def trigger_resources(trigger)
+    udid = rand
+    res = @resources.select { |_,v| v[:triggers].include?(trigger) }
+    res.each { |r,_| update_resource(r, udid) }
+  end
+
+  def update_all_resources
+    udid = rand
+    @resources.keys.each { |d| update_resource(d, udid) }
+  end
+end

data/lib/kaicho/version.rb

@@ -0,0 +1,3 @@
+module Kaicho
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: kaicho
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stone Tickle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- lattis@mochiro.moe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kaicho.gemspec
+- lib/kaicho.rb
+- lib/kaicho/version.rb
+homepage: https://github.com/annacrombie/kaicho
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: a resource manager
+test_files: []