agrippa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4710299d6af0fbb54f66ea2c0b9067c7515a3dc
+  data.tar.gz: 0026e7579d2ed5f0e3a84108cee928d4f61c6800
+SHA512:
+  metadata.gz: 89986cec264e3f44c3390f9a08770386944cc3bd24a37eae6358e7cbf3b9fc12d3f0522904a8d2dec0ba33e34c19c17a083c045b77f10893e7fd7ec2ddf44d9e
+  data.tar.gz: b8d2cf932c752fd5646ad58858f4ce68d8f07a37efbf1243ba16ee57031d48191e0c09329a526d1e147b2f1b662cf784563c779e96a2f0240917673e2e016e2e

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.sw?
+*.DS_Store
+/log/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reasonable.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+rspec_options = { cmd: "bundle exec rspec", all_on_start: false,
+    all_after_pass: false }
+guard "rspec", rspec_options do
+    watch("spec/spec_helper.rb") { "spec" }
+    watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+    watch(%r{^lib/.+\.rb$}) { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,186 @@
+# Agrippa
+
+Programming is hard. Complexity makes it harder. Agrippa helps with
+organizing complexity, by providing easy access to some very useful
+functional programming tools for otherwise stock-vanilla Ruby. 
+
+Agrippa has no external dependencies, unless you use `Agrippa::Immutable`,
+in which case you will also need the `hamster` gem.
+
+## Installation
+
+Run `gem install agrippa`, or add `gem "agrippa"` to your `Gemfile`.
+
+Seriously, it's a ruby gem. We all know how this works.
+
+## What the hell do you do with it?
+
+First, read [this article on reasonable
+programming](http://werve.net/articles/reasonable-programming).
+
+Fundamentally, programming consists of only three activities: accepting
+data, changing data, and returning data. Programs have inputs,
+transformations, and outputs.
+
+We can use this observation to help break down our methods into one of three
+categories. Command methods change state, transform methods change data from
+one form to another, and query methods return state.
+
+In functional programming parlance, only commands are allowed to have side
+effects, transforms
+
+If you have read 
+[Practical Object-Oriented Design in Ruby](http://www.poodr.com/) by Sandi
+Metz, then this probably sounds very familiar, but we're going to add a few
+extra rules to 
+
+This behavior can be applied to objects, and more importantly to 
+
+As methods or functions are the real meat of what any given program does,
+logic dictates that we can
+
+1. All methods are either query, command, or transform.
+
+2. Objects receive state via `initialize` or from command methods.
+
+3. Compose complex things from collections of simpler things.
+
+#### State Management
+
+```ruby
+require "agrippa"
+
+class MailConfig
+    include Agrippa::Mutable
+
+    state_reader :email, :password, :use_ssl, :server
+
+    def default_state
+        { use_ssl: true }
+    end
+end
+
+config = Config.new()
+
+```
+
+`Agrippa` provides three modules for managing state within in an object: 
+`Agrippa::Mutable`, `Agrippa::MutableHash`, and `Agrippa::Immutable`.
+
+Each of these modules implements the same interface, as they are designed to
+be interchangeable.
+
+state_reader
+state_writer
+state_accessor
+
+prefix
+suffix
+
+default_state
+
+fetch
+store
+chain
+
+fetch and store work identical to their Hash equivalents.
+chain works the same as merge
+
+initialize sets state
+
+`Agrippa::Mutable` stores values in individual instance variables. This uses
+half the memory of `Agrippa::MutableHash`, but is notably slower when
+initializing or chaining. As the name indicates, state for
+`Agrippa::Mutable` objects is mutated in-place.
+
+`Agrippa::MutableHash` stores data in a single `@state` hash, which is
+faster than `Agrippa::Mutable`, but consumes more memory. As all state for
+an object is contained in `@state`, serialization is dead simple.
+`Agrippa::MutableHash` also mutates the `@state` hash in-place.
+
+`Agrippa::Immutable` works like MutableHash, but `@state` is provided by
+`Hamster::Hash`, and the object itself is immutable, so `fetch` and `chain`
+return new instances of the object, rather than the object with state
+mutated in-place.
+
+state_reader
+state_writer
+state_accessor
+
+prefix
+suffix
+
+default_state
+
+fetch
+store
+chain
+
+fetch and store work identical to their Hash equivalents.
+chain works the same as merge
+
+initialize sets state
+
+to override setting, define a setter and call it in the initializer
+
+Agrippa objects treat symbols and strings as identical (so, they work the
+same as HashWithIndifferentAccess)
+
+Agrippa::Methods
+
+mark_as_command
+mark_as_commands
+command_methods
+
+Command methods are used by proxies.
+
+Agrippa::Proxy
+
+## Delegation.
+
+Delegation is the real core of what makes object-oriented code sing, as it
+enables the composition of complex behaviors from simpler objects.
+
+`Agrippa::Delegation` works the same as `ActiveSupport::Delegation`, with
+a few small additions.
+
+You can apply a 
+
+delegate
+to: method
+to: :class
+prefix
+    true
+    value
+suffix
+    true
+    value
+
+class_delegate
+
+delegate_command
+
+Agrippa::State
+Agrippa::Maybe
+
+## Examples
+
+```ruby
+
+```
+
+## Why does the name sound like a kitchen gadget?
+
+Because you have spent too much time in Williams Sonoma, and not enough time
+in a library.
+
+Agrippa is named after [Marcus Vipsanius
+Agrippa](https://en.wikipedia.org/wiki/Marcus_Vipsanius_Agrippa), a Roman
+statesman and architect. Amongst other achievements, he was responsible for
+renovating the aqueducts in Rome to give all citizens, from every social
+class, access to the highest possible quality of water.
+
+## Contributing
+
+When submitting pull requests, please respect the coding style of the
+project.

data/Rakefile

@@ -0,0 +1,13 @@
+root = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift(root) unless $LOAD_PATH.include?(root)
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :console do
+    require "pry"
+    ARGV.clear
+    Pry.start
+end

data/agrippa.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "agrippa/version"
+
+Gem::Specification.new do |spec|
+    spec.name = "agrippa"
+    spec.version = Agrippa::VERSION
+    spec.authors = ["Don Werve"]
+    spec.email = ["don@werve.net"]
+    spec.summary = %q{Tools for building better code.}
+    spec.description = %q{A small collection of design patterns, codified in a gem for easy reuse.}
+    spec.homepage = "https://github.com/mataton/agrippa/"
+    spec.license = "Apache-2.0"
+    spec.files = `git ls-files -z`.split("\x0")
+    spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+    spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+    spec.require_paths = ["lib"]
+    spec.add_development_dependency "bundler", "~> 1.6"
+    spec.add_development_dependency "rake", "~> 10.0"
+    spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
+    spec.add_development_dependency "guard", "~> 2.8"
+    spec.add_development_dependency "guard-rspec", "~> 4.3"
+    spec.add_development_dependency "ruby_gntp", "~> 0"
+    spec.add_development_dependency "simplecov", "~> 0"
+    spec.add_development_dependency "pry", "~> 0"
+    spec.add_development_dependency 'hamster', '~> 1.0', '>= 1.0.0'
+end