agrippa 0.0.1

data/spec/shared/state_container_examples.rb

@@ -0,0 +1,150 @@
+RSpec.shared_examples_for "a state container" do
+    let(:random_value) { Object.new }
+
+    let(:instance) { klass.new }
+
+    describe "#new" do
+        it "empty" do
+            expect { klass.new }.to_not raise_error
+        end
+
+        it "hash" do
+            expect { klass.new(a: random_value, "b" => 2) }.to_not raise_error
+        end
+
+        it "otherwise explodes" do
+            expect { klass.new(42) }.to raise_error(ArgumentError)
+        end
+    end
+
+    describe ".state_reader" do
+        it "returns a value" do
+            klass.state_reader :a
+            expect(instance).to respond_to(:a)
+            expect(instance.a).to be(nil)
+        end
+
+        it "not command method" do
+            klass.state_reader :a
+            expect(klass.command_method?(:a)).to_not be(true)
+        end
+
+        it "prefix" do
+            klass.state_reader :a, prefix: "foo"
+            expect(instance).to respond_to(:foo_a)
+        end
+
+        it "suffix" do
+            klass.state_reader :a, suffix: "foo"
+            expect(instance).to respond_to(:a_foo)
+        end
+    end
+
+    describe ".state_writer" do
+        it "chainable" do
+            klass.state_writer :a
+            expect(instance).to respond_to(:set_a)
+            expect(instance.set_a(:value)).to be_a(klass)
+        end
+
+        it "command method" do
+            klass.state_writer :a
+            expect(klass.command_method?(:set_a)).to be(true)
+        end
+
+        it "prefix" do
+            klass.state_writer :a, prefix: "foo"
+            expect(instance).to respond_to(:set_foo_a)
+        end
+
+        it "no prefix" do
+            klass.state_writer :a, prefix: false
+            expect(instance).to respond_to(:a)
+        end
+
+        it "suffix" do
+            klass.state_writer :a, suffix: "foo"
+            expect(instance).to respond_to(:set_a_foo)
+        end
+    end
+
+    it ".state_accessor builds both" do
+        klass.state_accessor :a
+        expect(instance).to respond_to(:a)
+        expect(instance).to respond_to(:set_a)
+    end
+
+    it "reader returns a value" do
+        klass.state_accessor :a
+        instance = klass.new(a: random_value)
+        expect(instance.a).to be(random_value)
+    end
+
+    it "writer sets a value" do
+        klass.state_accessor :a
+        expect(instance.set_a(2).a).to eq(2)
+    end
+
+    it "#chain command method" do
+        expect(klass.command_method?(:chain)).to be(true)
+    end
+
+    it "#chain sets multiple values" do
+        klass.state_accessor :a, :b
+        updated = instance.chain(a: random_value, b: 2)
+        expect(updated).to be_a(klass)
+        expect(updated.a).to be(random_value)
+        expect(updated.b).to eq(2)
+    end
+
+    it "#store" do
+        klass.state_accessor :a
+        updated = instance.store(:a, random_value)
+        expect(updated).to be_a(klass)
+        expect(updated.a).to be(random_value)
+    end
+
+    it "#store indifferent on symbols and strings" do
+        klass.state_accessor :a, :b
+        expect(instance.store(:a, 1).a).to eq(1)
+        expect(instance.store("b", 2).b).to eq(2)
+    end
+
+    it "#store command method" do
+        expect(klass.command_method?(:store)).to be(true)
+    end
+
+    it "#fetch" do
+        klass.state_accessor :a
+        expect(instance.store(:a, random_value).fetch(:a)).to be(random_value)
+    end
+
+    it "#fetch default" do
+        klass.state_accessor :a
+        expect(instance.fetch(:a, random_value)).to be(random_value)
+    end
+
+    it "#fetch not command method" do
+        expect(klass.command_method?(:fetch)).to be(false)
+    end
+
+    it "#fetch indifferent on symbols and strings" do
+        updated = instance.store(:a, 1)
+        expect(updated.fetch(:a)).to eq(1)
+        expect(updated.fetch("a")).to eq(1)
+    end
+
+    it "#default_state" do
+        klass.state_accessor :a
+        klass.send(:define_method, :default_state) { { a: "default" } }
+        expect(instance.a).to eq("default")
+    end
+
+    it "#default_state and new(state)" do
+        klass.state_accessor :a, :b
+        klass.send(:define_method, :default_state) { { a: 1 } }
+        instance = klass.new(b: 2)
+        expect(instance.a).to eq(1)
+        expect(instance.b).to eq(2)
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+root = File.join(File.dirname(File.expand_path(__FILE__)), "..")
+$LOAD_PATH.unshift(root) unless $LOAD_PATH.include?(root)
+
+require "simplecov"
+
+SimpleCov.start do
+    add_filter "/spec/"
+end
+
+RSpec.configure do |config|
+    config.filter_run(:focus)
+    config.run_all_when_everything_filtered = true
+    config.order = :random
+    config.default_formatter = "doc" if config.files_to_run.one?
+    Kernel.srand(config.seed)
+
+    config.expect_with :rspec do |expectations|
+        expectations.syntax = :expect
+    end
+
+    config.mock_with :rspec do |mocks|
+        mocks.syntax = :expect
+        mocks.verify_partial_doubles = true
+    end
+end

data/spec/state_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+require "agrippa/state"
+
+RSpec.describe Agrippa::State do
+    it "command methods update" do
+        value = double(ping: "pong", :command_method? => true)
+        proxy = Agrippa::State.new(value)
+        expect(proxy.ping.__id__).to eq(proxy.__id__)
+        expect(proxy._value).to eq("pong")
+    end
+
+    it "query methods return" do
+        value = double(ping: "pong", :command_method? => false)
+        proxy = Agrippa::State.new(value, :ping)
+        expect(proxy.ping).to eq("pong")
+    end
+end

data/spec/utilities_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+require "agrippa"
+
+RSpec.describe Agrippa::Utilities do
+    def try_require(*args)
+        Agrippa::Utilities.try_require(*args)
+    end
+
+    it "#try_require success" do
+        expect { try_require("securerandom") }.to_not raise_error
+    end
+
+    it "#try_require fail" do
+        expect { try_require("totallynotagem") }.to_not raise_error
+    end
+
+    it "#try_require fail message" do
+        expect { try_require("totallynotagem", "XXX") }
+            .to raise_error(LoadError, /XXX/)
+    end
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: agrippa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Don Werve
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A small collection of design patterns, codified in a gem for easy reuse.
+email:
+- don@werve.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- agrippa.gemspec
+- lib/agrippa.rb
+- lib/agrippa/accessor_methods.rb
+- lib/agrippa/delegation.rb
+- lib/agrippa/immutable.rb
+- lib/agrippa/maybe.rb
+- lib/agrippa/methods.rb
+- lib/agrippa/mutable.rb
+- lib/agrippa/mutable_hash.rb
+- lib/agrippa/proxy.rb
+- lib/agrippa/state.rb
+- lib/agrippa/utilities.rb
+- lib/agrippa/version.rb
+- spec/delegation_spec.rb
+- spec/immutable_spec.rb
+- spec/maybe_spec.rb
+- spec/methods_spec.rb
+- spec/mutable_hash_spec.rb
+- spec/mutable_spec.rb
+- spec/object_state_spec.rb
+- spec/proxy_spec.rb
+- spec/shared/state_container_examples.rb
+- spec/spec_helper.rb
+- spec/state_spec.rb
+- spec/utilities_spec.rb
+homepage: https://github.com/mataton/agrippa/
+licenses:
+- Apache-2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Tools for building better code.
+test_files:
+- spec/delegation_spec.rb
+- spec/immutable_spec.rb
+- spec/maybe_spec.rb
+- spec/methods_spec.rb
+- spec/mutable_hash_spec.rb
+- spec/mutable_spec.rb
+- spec/object_state_spec.rb
+- spec/proxy_spec.rb
+- spec/shared/state_container_examples.rb
+- spec/spec_helper.rb
+- spec/state_spec.rb
+- spec/utilities_spec.rb