about_pos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d68d749d2f08127f80633e1e9f9ee604ac87b087
+  data.tar.gz: 63038ab28ff4774823a34d6e184a9d8fc98f14f9
+SHA512:
+  metadata.gz: d09008e484f098deb5b3f4f790d82f16fef25fa886cdd4f3a12f1071a2021cfe933e84a2781c9fc0f97683e75737f01a2c9bd8fdd75f4229cbc4ebf489b030e2
+  data.tar.gz: f2e5401988650543456e323a64d093b7c13eeeb57c97b3829958b63d54b3872241f6f1a70e55c9fb1f93245666e656b037993dccb42b13e982d4066354a12d33

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+
+Copyright (c) 2014 da99
+
+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,18 @@
+
+# About\_Pos
+
+Loop through an array and keep track of previous, next item, current item, etc
+
+## Installation
+
+    gem 'about_pos'
+
+## Usage
+
+No coming any time soon.
+
+## The Essence of the Implementation
+
+  * `meta.next`, `meta.prev`.
+  * saving data (`[]`, `[]=`) and keep sure
+    the data is carried over to the other items.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/about_pos.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "about_pos"
+  spec.version       = `cat VERSION`
+  spec.authors       = ["da99"]
+  spec.email         = ["i-hate-spam-1234567@mailinator.com"]
+  spec.summary       = %q{Provide more meta info while you  loop back/forth on your arrays.}
+  spec.description   = %q{
+    Whenever I loop through an array, there are times I wish I could
+    know what comes before or after the item I am currently one.
+    Including prev/next index calculations.  This gem helps you with
+    that. However, it would be better for you to create your own
+    since you will probably not like my way of doing it.
+  }
+  spec.homepage      = "https://github.com/da99/about_pos"
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bacon"
+  spec.add_development_dependency "Bacon_Colored"
+  spec.add_development_dependency "pry"
+end

data/bin/test

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+# -*- bash -*-
+#
+#
+set -u -e -o pipefail
+
+files="$(find specs/ -maxdepth 1 -type f -iname "*.rb" -and -not -iname "helpers.rb")"
+if [[ -z "$files" ]]; then
+  colorize yellow "No tests found." 1>&2
+  exit 0
+else
+  bundle exec bacon specs/helpers.rb $files "$@"
+fi

data/lib/about_pos.rb

@@ -0,0 +1,154 @@
+
+class About_Pos
+
+  No_Next = Class.new(RuntimeError)
+  No_Prev = Class.new(RuntimeError)
+
+  class << self
+
+    def Back arr, &blok
+      Move(:back, arr, &blok)
+    end
+
+    def Forward arr, &blok
+      Move(:forward, arr, &blok)
+    end
+
+    private
+    def Move dir, arr
+      size = arr.size
+
+      if dir == :forward
+        real_index = 0
+        seq = arr
+      else
+        real_index = (size - 1) - 0
+        seq = arr.reverse
+      end
+
+      meta = Meta.new(dir, real_index, 0, arr)
+
+      seq.each_with_index { |v, i|
+        yield meta.value, meta.real_index, meta
+        (meta = meta.next) if meta.next?
+      }
+    end
+
+  end # === class self ===
+
+  class Meta
+
+    def initialize dir, real_index, i, arr, prev = nil
+      @arr        = arr
+      @data       = {}
+      @dir        = dir
+      @last_index = arr.size - 1
+
+      @real_index = real_index
+      @value      = arr[real_index]
+      @i          = i
+
+      @next = nil
+      @prev = prev
+    end
+
+    [
+      :arr,
+      :real_index,
+      :last_index,
+      :value, :i
+    ].each { |v|
+      eval %~
+        def #{v}
+          raise "Value not set for: #{v}" if @#{v}.nil?
+          @#{v}
+        end
+      ~
+    }
+
+    def next
+      @msg ||= if forward?
+                 "This is the last position."
+               else
+                 "This is the first position."
+               end
+      raise No_Next, @msg if !next?
+
+      @next ||= begin
+                  if forward?
+                    Meta.new(dir, real_index + 1, self.i + 1, arr, self)
+                  else
+                    Meta.new(dir, real_index - 1, self.i - 1, arr, self)
+                  end
+                end
+    end
+
+    def prev
+      @msg ||= if forward?
+                 "This is the first position."
+               else
+                 "This is the last position."
+               end
+      raise No_Prev, @msg if !prev?
+
+      @prev ||= begin
+                  if forward?
+                    Meta.new(dir, real_index - 1, self.i - 1, arr)
+                  else
+                    Meta.new(dir, real_index + 1, self.i + 1, arr)
+                  end
+                end
+    end
+
+    def dir
+      @dir
+    end
+
+    def back?
+      dir == :back
+    end
+
+    def forward?
+      dir == :forward
+    end
+
+    def next?
+      if forward?
+        real_index != last_index
+      else
+        real_index != 0
+      end
+    end
+
+    def prev?
+      if forward?
+        real_index != 0
+      else
+        real_index != last_index
+      end
+    end
+
+    def top?
+      real_index == 0
+    end
+
+    def middle?
+      real_index != 0 && real_index != last_index
+    end
+
+    def bottom?
+      real_index == last_index
+    end
+
+    def [] k
+      @data[k]
+    end
+
+    def []= k, v
+      @data[k] = v
+    end
+
+  end # === class Meta ===
+
+
+end # === class About_Pos ===

data/specs/Back.rb

@@ -0,0 +1,96 @@
+
+describe "Back" do
+
+  it "runs items in reverse" do
+    track = []
+    About_Pos.Back([1,2,3]) do |v, i, m|
+      track.push v
+    end
+    track.should == [3,2,1]
+  end
+
+  it "provides the real index" do
+    track = []
+    About_Pos.Back([1,2,3]) do |v, i, m|
+      track.push i
+    end
+    track.should == [2, 1, 0]
+  end
+
+  describe "Meta" do
+
+    describe "prev?" do
+
+      it "is false when at first item (real last item)" do
+        track = []
+        About_Pos.Back([1,2,3]) do |v, i, m|
+          track.push m.prev?
+        end
+        track.should == [false, true, true]
+      end
+
+    end # === describe prev? ===
+
+    describe "next?" do
+
+      it "is first if it reaches the last item (real first item)" do
+        track = []
+        About_Pos.Back([4,5,6]) do |v,i,m|
+          track.push m.next?
+        end
+        track.should == [true, true, false]
+      end
+
+    end # === describe next? ===
+
+    describe "prev" do
+
+      it "has value of previous item" do
+        track = []
+        About_Pos.Back([8,9,1,2]) do |v,i,m|
+          track.push(m.prev? ? m.prev.value : nil)
+        end
+        track.should == [nil, 2, 1, 9]
+      end
+
+      it "holds data from previous iterations" do
+        track = []
+        vals = [:a, :b, :c, :d]
+        About_Pos.Back([8,9,1,2]) do |v,i,m|
+          if m.prev?
+            track.push m.prev[:test_val]
+          else
+            track.push nil
+          end
+          m[:test_val] = vals.shift
+        end
+        track.should == [nil, :a, :b, :c]
+      end
+
+    end # === describe prev ===
+
+    describe "next" do
+
+      it "has value of next item" do
+        track = []
+        About_Pos.Back([1,2,3,4]) do |v,i,m|
+          track.push(m.next? ? m.next.value : nil)
+        end
+        track.should == [3, 2, 1, nil]
+      end
+
+      it "saves data that is accesible in the next iteration" do
+        track = []
+        vals = [:a, :b, :c]
+        About_Pos.Back([1,2,3]) { | v, i, m |
+          (m.next[:test_val] = vals.shift) if m.next?
+          track.push(m[:test_val])
+        }
+        track.should == [nil, :a, :b]
+      end
+
+    end # === describe next ===
+
+  end # === describe Meta ===
+
+end # === describe about_pos ===

data/specs/Forward.rb

@@ -0,0 +1,122 @@
+
+describe "Forward" do
+
+  it "runs items in forward fashion" do
+    track = []
+    About_Pos.Forward([1,2,3]) do |v, i, m|
+      track.push v
+    end
+    track.should == [1,2,3]
+  end
+
+  it "provides the real index" do
+    track = []
+    About_Pos.Forward([1,2,3,4]) do | v, i, m |
+      track.push i
+    end
+    track.should == [0,1,2,3]
+  end
+
+  describe "Meta" do
+
+    describe "prev?" do
+      it "is false when index == 0" do
+        track = []
+        About_Pos.Forward([1,2,3,4]) do | v, i, m |
+          track.push m.prev?
+        end
+        track.should == [false, true, true, true]
+      end
+    end # === describe prev? ===
+
+    describe "next?" do
+      it "is false when index == last index" do
+        track = []
+        About_Pos.Forward([1,2,3,4]) do | v, i, m |
+          track.push m.next?
+        end
+        track.should == [true, true, true, false]
+      end
+    end # === describe next? ===
+
+    describe "next" do
+
+      it "contains .value for next" do
+        track = []
+        About_Pos.Forward([1,2,3,4]) do | v, i, m |
+          track.push(m.next.value) if m.next?
+        end
+        track.should == [2,3,4]
+      end
+
+      it "raises an error if there is no next value" do
+        lambda {
+          About_Pos.Forward([1,2,3,4]) do | v, i, m |
+            m.next
+          end
+        }.should.raise(About_Pos::No_Next)
+        .message.should.match /This is the last position/i
+      end
+
+    end # === describe next ===
+
+    describe "prev" do
+
+      it "contains a .value for prev" do
+        track = []
+        About_Pos.Forward([1,2,3,4]) do | v, i, m |
+          track.push(m.prev.value) if m.prev?
+        end
+        track.should == [1,2,3]
+      end
+
+      it "raises an error if there is no prev value" do
+        lambda {
+          About_Pos.Forward([1,2,3,4]) do | v, i, m |
+            m.prev
+          end
+        }.should.raise(About_Pos::No_Prev)
+        .message.should.match /This is the first position/i
+      end
+
+    end # === describe prev ===
+
+    describe "saving/reading data ([], []=)" do
+
+      it "saves a value to be used on .prev meta" do
+        vals   = [:a, :b, :c]
+        track  = []
+        About_Pos.Forward([1,2,3,4]) do | v, i, m |
+          m[:test_val] = vals.shift
+
+          if m.prev?
+            track.push( m.prev[:test_val] )
+          else
+            track.push nil
+          end
+        end
+        track.should == [nil,:a,:b,:c]
+      end
+
+      it "saves a value to be used on .next meta" do
+        vals = [:d, :e, :f]
+        track = []
+        About_Pos.Forward([1,2,3,4]) do |v,i,m|
+          if m.next?
+            m.next[:test_val] = vals.shift
+          end
+          track.push m[:test_val]
+        end
+        track.should == [nil, :d, :e, :f]
+      end
+
+    end # === describe []/[]= ===
+
+  end # === describe Meta ===
+
+end # === describe about_pos ===
+
+
+
+
+

data/specs/helpers.rb

@@ -0,0 +1,4 @@
+
+require 'Bacon_Colored'
+require 'about_pos'
+require 'pry'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: about_pos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- da99
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bacon
+  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: Bacon_Colored
+  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'
+description: "\n    Whenever I loop through an array, there are times I wish I could\n
+  \   know what comes before or after the item I am currently one.\n    Including
+  prev/next index calculations.  This gem helps you with\n    that. However, it would
+  be better for you to create your own\n    since you will probably not like my way
+  of doing it.\n  "
+email:
+- i-hate-spam-1234567@mailinator.com
+executables:
+- test
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- VERSION
+- about_pos.gemspec
+- bin/test
+- lib/about_pos.rb
+- specs/Back.rb
+- specs/Forward.rb
+- specs/helpers.rb
+homepage: https://github.com/da99/about_pos
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provide more meta info while you  loop back/forth on your arrays.
+test_files: []