linesman 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDU1OTQ0OGQzYTM0ZWVjYjVlYzkzYTU5MTYwMDM0ZmQ5ODg0Y2E3MQ==
+  data.tar.gz: !binary |-
+    ZTEyNzFmZWQ2MjVjMDA0OWI5NTFmNzlkMTc4MzM3NDI5OTZiMDA5Mg==
+SHA512:
+  metadata.gz: !binary |-
+    MTEyNGE3NGVkZTkzZjA1OTU5ODUwMzgyZWUxZjI3OTUwMTAyMGIxYjZmNjE5
+    MzFiOTA5MDc1YTE0ZGY4MzcxMGQyMWU5Mzk1MTYwNjVmY2E3NmRjY2MzZjA1
+    MTExNTI0Nzk0NmJhMWEwYjMyNmUyNmQxNzgxNDRlYzIyNDM0YWU=
+  data.tar.gz: !binary |-
+    NmExNDE1OTViZWI3YTc1YWViZDk3NjI5NmY1MWUwMzRkN2RjZWNlZjVjZWIw
+    NGI5NTMxZTJlMzBjNDQ5OTE3MzJkZDcwOTdkOGM1YjVkZmRiYjE0ZDcyNTNl
+    MjkyZTY3YjZhMzEyZTdjYjExNDE0NmI5MDM3YjliOGI5YjcyYTg=

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle
+/log/*.log
+/tmp
+*~
+*.swp
+/pkg
+/bin
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'simplecov', require: false
+end

data/HISTORY.md

@@ -0,0 +1 @@
+* 0.0.1 - Initial Release

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Dennis Walters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+## Linesman ##
+
+Determine if a value is in-bounds
+
+## Gem Setup ##
+
+```ruby
+gem install linesman
+
+# Gemfile
+gem 'linesman'
+```
+## How Do I Use This Thing? ##
+
+There's not really much to it. There is only one method: Linesman.within_bounds?
+
+It takes an option hash and a block.
+
+The options hash must contain at least one of the following:
+
+* :exactly
+* :min
+* :max
+
+The block should return a value that is comparable to the bounds specified in
+the options hash.
+
+The method returns either true or false based on the given criteria.
+
+Examples:
+
+```ruby
+Linesman.within_bounds?(exactly: 1) {2 - 1} # => true
+
+Linesman.within_bounds?(min: 1, max: 10) {1} # => true
+Linesman.within_bounds?(min: 1) {0} # => false
+Linesman.within_bounds?(max: 1) {0} # => true
+```
+
+## Formal Documentation ##
+
+The actual library docs can be read
+[over on rubydoc](http://rubydoc.info/gems/linesman/frames).
+
+## Contributing ##
+
+Do you use git-flow? I sure do. Please base anything you do off of
+[the develop branch](https://github.com/ess/linesman/tree/develop).
+
+1. Fork it.
+2. Perform some BDD magic. Seriously. Be testing.
+3. Submit a pull request.
+
+## So, Uh, Why? ##
+
+In short, I've been needing this exact functionality all over the place of
+late, and it was quick enough to just throw it together.
+
+## License ##
+
+MIT License. Copyright 2013 Ess

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/linesman/version.rb

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

data/lib/linesman.rb

@@ -0,0 +1,28 @@
+require 'linesman/version'
+
+module Linesman
+  def self.within_bounds?(options = {}, &block)
+    at_least_one = [:exactly, :min, :max]
+    unless at_least_one.map {|key| options.has_key?(key)}.any? {|present| present}
+      raise ArgumentError.new('At least one of the following is required: :exactly, :min, :max')
+    end
+
+    raise ArgumentError.new('a block is required') if block.nil?
+
+    exactly = options[:exactly]
+    min = options[:min]
+    max = options[:max]
+
+    under_scrutiny = block.call
+
+    if exactly
+      return under_scrutiny == exactly
+    elsif min && max
+      return under_scrutiny >= min && under_scrutiny <= max
+    elsif min
+      return under_scrutiny >= min
+    else
+      return under_scrutiny <= max
+    end
+  end
+end

data/linesman.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/linesman/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dennis Walters"]
+  gem.email         = ["dennis@elevatorup.com"]
+  gem.summary       = %q{Determines if values are in bounds}
+  gem.description   = <<-EOD
+    Linesman is a simple module that helps one determine if a
+    value is within a given set of bounds.
+  EOD
+  gem.homepage      = "http://github.com/ess/linesman"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "linesman"
+  gem.require_paths = ["lib"]
+  gem.version       = Linesman::VERSION
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/linesman_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'linesman'
+
+describe Linesman do
+  let(:klass) {Linesman}
+
+  describe '.within_bounds?' do
+    it 'requires :exactly or some combination of :min and :max' do
+      expect {klass.within_bounds?() {}}.to raise_error(ArgumentError)
+      expect {klass.within_bounds?(exactly: 1) {1}}.not_to raise_error
+      expect {klass.within_bounds?(min: 1) {1}}.not_to raise_error
+      expect {klass.within_bounds?(max: 1) {1}}.not_to raise_error
+      expect {klass.within_bounds?(exactly: 1, min: 1, max: 1) {1}}.not_to raise_error
+    end
+
+    it 'requires a block' do
+      expect {klass.within_bounds?(exactly: 1)}.to raise_error(ArgumentError)
+      expect {klass.within_bounds?(exactly: 1) {0}}.not_to raise_error
+    end
+
+    context 'with :exactly specified' do
+      it 'ignores :min and :max' do
+        expect(klass.within_bounds?(exactly: 1, min: 2) {1}).to be_true
+        expect(klass.within_bounds?(exactly: 1, max: 0) {1}).to be_true
+      end
+
+      it 'is true if the block value is exactly as specified' do
+        expect(klass.within_bounds?(exactly: 1) {1}).to be_true
+      end
+
+      it 'is false if the block value is not exactly as specified' do
+        expect(klass.within_bounds?(exactly: 1) {0}).to be_false
+      end
+    end
+
+    context 'with :min specified' do
+      it 'is true if the block value is at least as specified' do
+        expect(klass.within_bounds?(min: 1) {1}).to be_true
+        expect(klass.within_bounds?(min: 1) {2}).to be_true
+      end
+
+      it 'is false if the block value is less than as specified' do
+        expect(klass.within_bounds?(min: 1) {0}).to be_false
+      end
+    end
+
+    context 'with :max specified' do
+      it 'is true if the block value is at most as specified' do
+        expect(klass.within_bounds?(max: 10) {10}).to be_true
+        expect(klass.within_bounds?(max: 10) {9}).to be_true
+      end
+
+      it 'is false if the block value is more than as specified' do
+        expect(klass.within_bounds?(max: 10) {11}).to be_false
+        expect(klass.within_bounds?(max: 10) {100}).to be_false
+      end
+    end
+
+    context 'with :min and :max specified' do
+      it 'is true if the block value is within the inclusive range min..max' do
+        min = 1
+        max = 10
+        (min..max).each do |value|
+          expect(klass.within_bounds?(min: min, max: max) {value}).to be_true
+        end
+      end
+
+      it 'is false if the block value is outside the inclusive range min..max' do
+        min = 10
+        max = 20
+        expect(klass.within_bounds?(min: min, max: max) {min - 1}).to be_false
+        expect(klass.within_bounds?(min: min, max: max) {max + 1}).to be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec/expectations'
+
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: linesman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: ! "    Linesman is a simple module that helps one determine if a\n    value
+  is within a given set of bounds.\n"
+email:
+- dennis@elevatorup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/linesman.rb
+- lib/linesman/version.rb
+- linesman.gemspec
+- spec/linesman_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ess/linesman
+licenses:
+- MIT
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Determines if values are in bounds
+test_files:
+- spec/linesman_spec.rb
+- spec/spec_helper.rb