decoplan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16d8edbe2f73f3661f359be93847e95ac3ba9100
+  data.tar.gz: fb8025a511723043829e2d83e13b424584861a8d
+SHA512:
+  metadata.gz: 1770eaa968445168a06843702ef67ddf22869e0b32358f6959a531de842ca3bac6cd69d9b3204ffabd9c5b85f7e4e29154501a8636a5216221bd2424cdd53ce5
+  data.tar.gz: d6aacd1d89f80543a7db004cc9e467fc861685005150a0a194585875f4b1cd668a0195b28c824dcc2aed4e3c30de43d94c3ad6f7b157861bad305f8b4a082675

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  rubocop:
+    enabled: false

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: false
+cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler
+  - gem --version
+  - bundle --version
+script:  rake travis:ci
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+branches:
+  only:
+    - master
+addons:
+  code_climate:
+    repo_token: 5bd70aa7d70fc8ce3a649a0a05c0119e9441fa174964c0a270c6e952bc75996d

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec
+
+group(:development) do
+  gem 'rspec',       '~> 3.0'
+  gem 'rake'
+  gem 'bundler-audit'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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,7 @@
+[![Build Status Master](https://travis-ci.org/lamont-granquist/decoplan.svg?branch=master)](https://travis-ci.org/lamont-granquist/decoplan)
+[![Code Climate](https://codeclimate.com/github/lamont-granquist/decoplan/badges/gpa.svg)](https://codeclimate.com/github/lamont-granquist/decoplan)
+[![Test Coverage](https://codeclimate.com/github/lamont-granquist/decoplan/badges/coverage.svg)](https://codeclimate.com/github/lamont-granquist/decoplan/coverage)
+[![Issue Count](https://codeclimate.com/github/lamont-granquist/decoplan/badges/issue_count.svg)](https://codeclimate.com/github/lamont-granquist/decoplan)
+
+this isn't usable yet.  stay tuned...
+

data/Rakefile

@@ -0,0 +1,28 @@
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+begin
+  namespace :bundle do
+    desc 'Updates the ruby-advisory-db then runs bundle-audit'
+    task :audit do
+      require 'bundler/audit/cli'
+      %w(update check).each do |command|
+        Bundler::Audit::CLI.start [command]
+      end
+    end
+  end
+rescue LoadError
+end
+
+namespace :travis do
+  desc 'Run test on Travis'
+  task ci: %w{spec bundle:audit}
+end
+
+task default: %w{spec bundle:audit}

data/bin/decoplan

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+Signal.trap('INT') { exit 1 }
+
+$:.push File.expand_path('../../lib', __FILE__)
+$stdout.sync = true
+
+require 'decoplan/runner'
+
+Encoding.default_external = Encoding::UTF_8
+Decoplan::Runner.new.run

data/decoplan.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'decoplan/version'
+
+Gem::Specification.new do |gem|
+  gem.name           = 'decoplan'
+  gem.version        = Decoplan::VERSION
+  gem.license        = 'Apache 2.0'
+  gem.author         = 'lamont@scriptkiddie.org'
+  gem.email          = 'lamont@scriptkiddie.org'
+  gem.summary        = 'Decoplanner with a Pry-based REPL.'
+  gem.description    = gem.summary
+  gem.homepage       = 'https://github.com/lamont-granquist/decoplan'
+
+  gem.required_ruby_version = '>= 2.1.0'
+
+  gem.files = `git ls-files`.split($/)
+  gem.bindir = 'bin'
+  gem.executables = %w(decoplan)
+  gem.test_files = gem.files.grep(/^spec\//)
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'pry'
+end

data/lib/decoplan/algorithm.rb

@@ -0,0 +1,7 @@
+module Decoplan
+  class Algorithm
+    def initialize(profile, *args)
+      @profile = profile
+    end
+  end
+end

data/lib/decoplan/algorithm/buhlmann.rb

@@ -0,0 +1,6 @@
+module Decoplan
+  class Algorithm
+    class Buhlmann < Algorithm
+    end
+  end
+end

data/lib/decoplan/algorithms.rb

@@ -0,0 +1 @@
+require 'decoplan/algorithm/buhlmann'

data/lib/decoplan/dive_profile.rb

@@ -0,0 +1,22 @@
+module Decoplan
+  class DiveProfile < BasicObject
+    attr_accessor :levels
+    attr_accessor :name
+
+    def initialize(name: nil)
+      @name = name
+      @levels = []
+    end
+
+    def level(depth:, time:)
+      levels.push({
+        depth: depth,
+        time: time,
+      })
+    end
+
+    def apply(algorithm, *params)
+      algorithm.new(self, *params)
+    end
+  end
+end

data/lib/decoplan/dsl.rb

@@ -0,0 +1,15 @@
+require 'decoplan/dive_profile'
+
+module Decoplan
+  module DSL
+    def dive(name = nil, &block)
+      dive = DiveProfile.new(name: name)
+      dive.instance_eval(&block) if block_given?
+      dive
+    end
+
+    def help
+      puts "FIXME: should give the user some help"
+    end
+  end
+end

data/lib/decoplan/runner.rb

@@ -0,0 +1,14 @@
+require 'pry'
+require 'decoplan/dsl'
+require 'decoplan/algorithms'  # hack for now
+
+module Decoplan
+  class Runner
+    def run
+      # FIXME: set _pry_.prompt, _pry_.prompt_name, possibly other _pry_ config vars
+      context = Class.new
+      context.extend(DSL)
+      context.class_eval { binding.pry }
+    end
+  end
+end

data/lib/decoplan/version.rb

@@ -0,0 +1,3 @@
+module Decoplan
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/unit/dive_profile_spec.rb

@@ -0,0 +1,36 @@
+require 'decoplan/dive_profile'
+
+RSpec.describe Decoplan::DiveProfile do
+  let(:name) { "test" }
+  let(:profile) { described_class.new(name: name) }
+
+  it "sets the name by default" do
+    expect(profile.name).to eql "test"
+  end
+
+  it "the name is nil by default" do
+    profile2 = described_class.new
+    expect(profile2.name).to be nil
+  end
+
+  it "the name has an accessor" do
+    profile.name = "changed"
+    expect(profile.name).to eql("changed")
+  end
+
+  it "there are no levels by default" do
+    expect(profile.levels).to eql([])
+  end
+
+  it "accepts a level argument" do
+    profile.level(depth: 100, time: 70)
+    expect(profile.levels).to eql([{depth: 100, time: 70}])
+  end
+
+  it "multiple levels can be set" do
+    profile.level(depth: 100, time: 20)
+    profile.level(depth: 120, time: 30)
+    profile.level(depth: 110, time: 10)
+    expect(profile.levels).to eql([{depth: 100, time: 20}, {depth: 120, time:30}, {depth:110, time:10}])
+  end
+end

data/spec/unit/dsl_spec.rb

@@ -0,0 +1,23 @@
+
+require 'decoplan/dsl'
+require 'decoplan/dive_profile'
+
+RSpec.describe Decoplan::DSL do
+  let(:dsl) { Class.new.extend(Decoplan::DSL) }
+
+  it "has a help method" do
+    dsl.help
+  end
+
+  it "dive can be used to construct a dive plan" do
+    dsl.dive
+  end
+
+  it "the default name of a dive is nil" do
+    expect(dsl.dive.name).to be nil
+  end
+
+  it "we can also set a name from the dsl" do
+    expect(dsl.dive("foo").name).to eql "foo"
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: decoplan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- lamont@scriptkiddie.org
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Decoplanner with a Pry-based REPL.
+email: lamont@scriptkiddie.org
+executables:
+- decoplan
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/decoplan
+- decoplan.gemspec
+- lib/decoplan/algorithm.rb
+- lib/decoplan/algorithm/buhlmann.rb
+- lib/decoplan/algorithms.rb
+- lib/decoplan/dive_profile.rb
+- lib/decoplan/dsl.rb
+- lib/decoplan/runner.rb
+- lib/decoplan/version.rb
+- spec/spec_helper.rb
+- spec/unit/dive_profile_spec.rb
+- spec/unit/dsl_spec.rb
+homepage: https://github.com/lamont-granquist/decoplan
+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: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Decoplanner with a Pry-based REPL.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/dive_profile_spec.rb
+- spec/unit/dsl_spec.rb