core_refinements 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2d59d91107058453403d3b53369385195b07f50
+  data.tar.gz: 07b1f6f9b5e175eb9284d0daa2f3bef9366638de
+SHA512:
+  metadata.gz: 4d2998316ccb4f5b27f4b32fa9fd39613821a7dea6865951f5a64c7febf2cf918f54edf721658c221b36c75fb0d4b42ea333844b7ae5120edf03f4763e696305
+  data.tar.gz: 0dfff658f84de2c4553a487d8030f94f4b98d99aee811000278092a70ec10436097bbd71afe4c650dad70357005ce30c349c0a557e1a02e44c7ada06288d45a7

data/.gitignore

@@ -0,0 +1,24 @@
+.idea
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+branches:
+  only:
+    - master
+    - development
+script: CODECLIMATE_REPO_TOKEN=69c1e6e298325a41b32512316f03a1e83a36a5707073cfdbe174d4362d7a237c bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in core_augmentations.gemspec
+gemspec
+group :development do
+  gem 'rspec'
+  gem 'guard', require:false
+  gem 'guard-rspec', require:false
+  gem 'guard-bundler', require:false
+  gem 'pry', require:false
+  gem "codeclimate-test-reporter", group: :test, require: nil
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ernie Brodeur
+
+MIT License
+
+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,39 @@
+# CoreAugmentations
+
+**Master** [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/erniebrodeur/core_refinements) [![Build Status](https://travis-ci.org/erniebrodeur/core_refinements.png?branch=master)](https://travis-ci.org/erniebrodeur/core_refinements) [![Dependency Status](https://gemnasium.com/erniebrodeur/core_refinements.png)](https://gemnasium.com/erniebrodeur/core_refinements)
+
+**Development** [![Build Status](https://travis-ci.org/erniebrodeur/core_refinements.png?branch=development)](https://travis-ci.org/erniebrodeur/core_refinements)
+
+
+A collection of (somewhat) simple additions to the base ruby classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'core_refinements'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install core_refinements
+
+## Usage
+
+Each method is contained in it's own file.  This allows us to extend only the methods we need as we need them.
+
+`require 'core_refinements/String/to_human'`
+
+All the methods have spec's, they don't have any documentation.  For now just browse the source directory to see
+what is available.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/core_refinements/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/WHATSNEW.md

@@ -0,0 +1,18 @@
+## (unreleased)
+
+## 0.1.5
+* renamed and converted to refinements instead of monkey patching.
+
+## 0.1.4
+* Updated Array#collapse_ranges to take a 'step' and a 'split' parameter (step size and a pre-split array).
+
+## 0.1.3
+* Added Object#add_option, a 'dsl' like method to add named options to an object.
+* Added Array#collapse_ranges, collapse a large array of numeric's into an array with optimal ranging.
+
+## 0.1.2
+* Added code climate coverage.
+
+## 0.1.1
+* Added travis-ci. gemnasium, and code climate.  All green (it's 12 lines of code so far).
+* Spec'ed everything I've included so far.

data/core_refinements.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'core_refinements/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "core_refinements"
+  spec.version       = CoreRefinements::VERSION
+  spec.authors       = ["Ernie Brodeur"]
+  spec.email         = ["ebrodeur@ujami.net"]
+  spec.summary       = "Methods to augment the core classes in ruby."
+  spec.description   = "A collection of methods that can be used to extend the basic ruby classes."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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"
+end

data/lib/core_augmentations/version.rb

@@ -0,0 +1,3 @@
+module CoreAugmentations
+  VERSION = "0.1.4"
+end

data/lib/core_refinements/Array/collapse_ranges.rb

@@ -0,0 +1,47 @@
+module CoreRefinements
+  module Array
+    module CollapseRanges
+      refine ::Array do
+        # collapse a given array into an array with ranges (and singular) entries.
+        def collapse_ranges(split: false, step: 1)
+          ungapped_array = []
+        	i = 0
+        	contiguous = false
+        	contiguous_start = nil
+        	contiguous_end = nil
+        	while (i < self.count)
+            current_n = self[i]
+            return nil unless current_n.kind_of? ::Numeric
+
+            next_n = self[i+1]
+            if next_n && current_n != next_n && ::Range.new(current_n, current_n + step).include?(next_n)
+        			# in a sequence and we know this is a part of the range since we have a start marker
+        			contiguous_start = i  unless contiguous_start
+        		else
+        			if contiguous_start
+        				# mark our end
+        				contiguous_end = i
+        				# turn it into a range
+        				range = self[contiguous_start]..self[contiguous_end]
+        				ungapped_array.push(range)
+                # clean everything up for the next range
+        				contiguous_start = nil
+        				contiguous_end = nil
+        			else
+                # normal number, just add to the output array
+        				ungapped_array.push current_n
+        			end
+        		end
+        		i += 1
+        	end
+
+          if split && ungapped_array.any?
+            return [ungapped_array.select {|i| i.class == ::Range},
+                    ungapped_array.select {|i| i.kind_of? ::Numeric}]
+          end
+        	return ungapped_array
+        end
+      end
+    end
+  end
+end

data/lib/core_refinements/Array/index_by.rb

@@ -0,0 +1,20 @@
+module CoreRefinements
+  module Array
+    module IndexBy
+      refine ::Array do
+        def index_by(position)
+          index = {}
+          self.each do |entry|
+            if entry.kind_of?(::Array) || entry.kind_of?(::Hash)
+              return nil unless entry[position]
+              return nil if index[entry[position]]
+              index[entry[position]] = entry
+            end
+          end
+
+          return index
+        end
+      end
+    end
+  end
+end

data/lib/core_refinements/Numeric/percentage_of.rb

@@ -0,0 +1,12 @@
+module CoreRefinements
+  module Numeric
+    module PercentageOf
+      class ::Numeric
+      	# return the percentage of a number, rounded to 2 places by default.
+        def percentage_of(n, round = 2)
+          return (self.to_f / n.to_f * 100.0).round(round)
+        end
+      end
+    end
+  end
+end

data/lib/core_refinements/Object/options.rb

@@ -0,0 +1,24 @@
+module CoreRefinements
+  module Object
+    module Options
+      refine ::Object do
+        # Add a trackable option to an object.  Creates a method for the key name.
+        def add_option(key = nil)
+          @_added_options ||= []
+          @_added_options.push(key.to_sym) unless @_added_options.include?(key.to_sym)
+          define_singleton_method(key) do |args = nil|
+            if !args
+              instance_variable_get("@#{key}")
+            else
+              instance_variable_set("@#{key}", args)
+            end
+          end
+        end
+
+        def list_options
+          return @_added_options ||= nil
+        end
+      end
+    end
+  end
+end

data/lib/core_refinements/String/to_human.rb

@@ -0,0 +1,14 @@
+module CoreRefinements
+  module String
+    module ToHuman
+      class ::String
+        # take a CamelCase or under_scored string and convert it to a human readable string (useful for output).
+        def to_human
+          return self.split("_").map {|word| word[0] + word[1..-1]}.join(" ") if self.include?("_")
+
+          return self.split(/(?=[A-Z])/).join(" ").downcase
+        end
+      end
+    end
+  end
+end

data/lib/core_refinements/version.rb

@@ -0,0 +1,3 @@
+module CoreRefinements
+  VERSION = "0.1.6"
+end

data/spec/lib/core_refinements/Array/collapse_ranges_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper.rb'
+require 'core_refinements/Array/collapse_ranges.rb'
+using CoreRefinements::Array::CollapseRanges
+
+describe Array do
+  describe "#collapse_ranges" do
+    it "Will return a collapsed range" do
+      expect([1,2,3,4,5,6,7,9,11,13,14,15].collapse_ranges).to eq [1..7,9,11,13..15]
+    end
+    it "Will not lose duplicates" do
+      expect([1,1,2,3,3,3,4,5].collapse_ranges).to eq [1,1..3,3,3..5]
+    end
+    it "will not need to be sorted" do
+      expect([4,5,6,1,2,3].collapse_ranges).to eq [4..6,1..3]
+    end
+    it "will return nil if it gets a non Numeric argument" do
+      expect([1,2,3,'a'].collapse_ranges).to be nil
+    end
+    it "Will 'split' the return into two parts (range,singles) with the parameter split." do
+      expect([1,2,3,5,7].collapse_ranges(split:true)).to eq([[1..3], [5, 7]])
+    end
+    it "Will allow a step parameter to include missing values in the ranges." do
+      complex_range = [13,1,2,3,4,6,8,11,14,17,20,25,30,35,2]
+      complex_2 = [13,1..8,11,14,17,20,25,30,35,2]
+      complex_5 = [13,1..35,2]
+      expect(complex_range.collapse_ranges(step:1)).to_not eq complex_2
+      expect(complex_range.collapse_ranges(step:2)).to eq complex_2
+      expect(complex_range.collapse_ranges(step:3)).to_not eq complex_2
+      expect(complex_range.collapse_ranges(step:4)).to_not eq complex_2
+      expect(complex_range.collapse_ranges(step:5)).to_not eq complex_2
+      expect(complex_range.collapse_ranges(step:5)).to eq complex_5
+    end
+  end
+end

data/spec/lib/core_refinements/Array/index_by_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper.rb'
+require 'core_refinements/Array/index_by'
+using CoreRefinements::Array::IndexBy
+describe CoreRefinements do
+  describe Array do
+    describe "#index_by" do
+      before (:all) do
+        @array = [
+          [1,2,3],
+          [4,5,6],
+          ['a','b','c'],
+          ['d','e','f'],
+          ['cat', 'dog', 'bird']
+        ]
+        @hash = [
+          {id:11, x:2, y:3},
+          {id:22, x:2, y:5},
+          {id:33, x:4, y:4}
+        ]
+      end
+      describe Hash do
+        it "Will index an array of hashes by key." do
+          new_hash = @hash.index_by :id
+          expect(new_hash[11]).to eq @hash.first
+        end
+        it "Will return nil if it can't find the key." do
+          expect(@hash.index_by :not_real).to be nil
+        end
+      end
+      describe Array do
+        it "Will index an array of hashes by position." do
+          new_array = @array.index_by 0
+          expect(new_array[@array.last.first]).to eq @array.last
+        end
+
+        it "Will return nil if it can't find the position." do
+          expect(@array.index_by @array.count+1).to be nil
+        end
+      end
+    end
+  end
+end

data/spec/lib/core_refinements/Numeric/percentage_of_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper.rb'
+require 'core_refinements/Numeric/percentage_of'
+using CoreRefinements::Numeric::PercentageOf
+
+describe Numeric do
+  describe "#percentage_of" do
+    # Goddamn, some days.  I really need to figure out how to phrase this better.
+    it "Given an argument, return the percentage of the number in self." do
+      expect(10.percentage_of(100)).to eq 10
+      expect(10.percentage_of(990)).to eq 1.01
+    end
+    it "Will round given a round: parameter." do
+      expect(10.percentage_of(667281,5)).to eq 0.0015
+    end
+  end
+end

data/spec/lib/core_refinements/Object/options_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper.rb'
+require 'core_refinements/Object/options.rb'
+using CoreRefinements::Object::Options
+
+describe CoreRefinements do
+  describe Object do
+    before (:each) do
+    end
+    describe '#add_option' do
+      it 'should add method by name or symbol' do
+        @test_object = Hash.new
+        @test_object.add_option('test_string')
+        expect(@test_object.methods.include?(:test_string)).to be true
+        @test_object = Hash.new
+        @test_object.add_option(:test_symbol)
+        expect(@test_object.methods.include?(:test_symbol)).to be true
+      end
+      it 'should return the argument passed to it' do
+        @test_object = Array.new
+        @test_object.add_option('test')
+        tests = [[1,2,3], 'this', 'that', :those, 5]
+        tests.each do |t|
+          @test_object.test t
+          expect(@test_object.test).to eq t
+        end
+      end
+    end
+    describe '#list_options' do
+      it "should return the list of options as an array when given no argument" do
+        @test_object = Array.new
+        @test_object.add_option('test')
+        @test_object.add_option(:test2)
+        expect(@test_object.list_options).to eq [:test, :test2]
+      end
+    end
+  end
+end

data/spec/lib/core_refinements/String/to_human_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper.rb'
+require 'core_refinements/String/to_human'
+using CoreRefinements::String::ToHuman
+
+describe String do
+  describe "#to_human" do
+    it "Will turn a CamelCase word into words with spaces." do
+      expect("CamelCasedWord".to_human).to eq "camel cased word"
+    end
+    it "Will transform underscored words into words with spaces." do
+      expect("underscored_words".to_human).to eq "underscored words"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: core_refinements
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Ernie Brodeur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A collection of methods that can be used to extend the basic ruby classes.
+email:
+- ebrodeur@ujami.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- WHATSNEW.md
+- core_refinements.gemspec
+- lib/core_augmentations/version.rb
+- lib/core_refinements.rb
+- lib/core_refinements/Array/collapse_ranges.rb
+- lib/core_refinements/Array/index_by.rb
+- lib/core_refinements/Numeric/percentage_of.rb
+- lib/core_refinements/Object/options.rb
+- lib/core_refinements/Object/save.rb
+- lib/core_refinements/String/to_human.rb
+- lib/core_refinements/version.rb
+- spec/lib/core_refinements/Array/collapse_ranges_spec.rb
+- spec/lib/core_refinements/Array/index_by_spec.rb
+- spec/lib/core_refinements/Numeric/percentage_of_spec.rb
+- spec/lib/core_refinements/Object/options_spec.rb
+- spec/lib/core_refinements/Object/save_spec.rb
+- spec/lib/core_refinements/String/to_human_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Methods to augment the core classes in ruby.
+test_files:
+- spec/lib/core_refinements/Array/collapse_ranges_spec.rb
+- spec/lib/core_refinements/Array/index_by_spec.rb
+- spec/lib/core_refinements/Numeric/percentage_of_spec.rb
+- spec/lib/core_refinements/Object/options_spec.rb
+- spec/lib/core_refinements/Object/save_spec.rb
+- spec/lib/core_refinements/String/to_human_spec.rb
+- spec/spec_helper.rb