silly_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d55d1fdb579cf3a572aef1336337d493b0778a19
+  data.tar.gz: 0d7a8e2d8bef6c1e4e6dd1f8e35806d81a899726
+SHA512:
+  metadata.gz: 60659c3c6e9104eb508bce1f726225f308f638e84e3b91c1fdf4b4436ebcad87624566d7b9da2325492868d88ab3fb0fef2c1438a9c95b4fd44bb5fc0ad14c31
+  data.tar.gz: 80165e6456dcb512de190c7573028eb345413cc5fe434f30c94704cf8707aa0624e60c405c3c80024f8cc501011431c290ce44ebea8885518da2d6f8cb717b14

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+silly_list

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Silicon Salad
+
+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,55 @@
+# SillyList
+
+Array like classes. Add Stack behavior, Queue is coming.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'silly_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install silly_list
+
+## Usage
+
+``` ruby
+  class NumberList << SillyList::UniqLifo
+  end
+
+  number_list = NumberList.new([1,2,3], max_size: 2)
+  number_list.list #=> [1,2]
+  number_list.add(3)
+  number_list.list #=> [3,1]
+  number_list.add(3)
+  number_list.list #=> [3,1]
+  number_list.add([4,5])
+  number_list.list #=> [4,5]
+  number_list.remove #=> 4
+  number_list.list #=> [5]
+```
+
+## Development
+
+Documenation:
+
+    $ bundle exec yard server --port 8828 --reload
+
+Tests:
+
+    $ rake spec
+
+## Contributing
+
+1. Fork it ( https://github.com/siliconsalad/silly_list/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/ROADMAP.md

@@ -0,0 +1,10 @@
+# ROADMAP #
+
+## v0.2.0 ##
+
+* Add Queue class
+
+## Ideas of improvements ##
+
+* Store list in session
+* Deal with ActiveRecord

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task default: :spec

data/lib/silly_list.rb

@@ -0,0 +1,6 @@
+require 'silly_list/version'
+require 'silly_list/uniq_lifo'
+
+module SillyList
+
+end

data/lib/silly_list/uniq_lifo.rb

@@ -0,0 +1,96 @@
+module SillyList
+  # Class UniqLifo designed to manage Last In First Out array (stack)
+  # It ensures that items are uniq.
+  #
+  # The array can have a max size or be illimited (then max_size must be 0)
+  #
+  # @example
+  #   my_array = SillyList::UniqLifo.new([1,2,3], max_size: 2)
+  #   my_array.list #=> [1,2]
+  #   my_array.add(3)
+  #   my_array.list #=> [3,1]
+  #   my_array.add([4,5])
+  #   my_array.list #=> [4,5]
+  #   my_array.remove #=> 4
+  #   my_array.list #=> [5]
+  class UniqLifo
+
+    attr_reader :list, :max_size
+
+    def initialize(list=[], max_size: 0)
+      @list     = init_list(list, max_size)
+      @max_size = max_size
+    end
+
+    # Checks if list is empty
+    #
+    # @return [Boolean]
+    def empty?
+      list.empty?
+    end
+
+    # Adds an item to the list
+    #
+    # @param [<Object, Array>] object to be added
+    # @return [UniqLifo]
+    def add(item)
+      return unless item
+
+      delete(item)
+      add_at_beginning(item)
+      remove_last if size_exceeded?
+
+      self
+    end
+
+    # Deletes the first item of the list
+    #
+    # @return [Object] removed item
+    def remove
+      list.delete_at(0)
+    end
+
+    private
+
+    # Removes the excess of items
+    #
+    # @return [Array<Object>] array of removed item
+    def remove_last
+      index = list.size - max_size
+      list.pop(index)
+    end
+
+    # Ensures that the list does not exceed the max size
+    #
+    # @param [Array<Object>] list to be initialized
+    # @param [Integer] max size
+    # @return [Array<Object>] list
+    def init_list(list, max_size)
+      list[0..max_size-1]
+    end
+
+    # Delete all the occurence of item in the list
+    #
+    # @param [Object] item to be deleted
+    # @return [Object, nil] deleted item or nil
+    def delete(item)
+      list.delete(item)
+    end
+
+    # Insert item at the beginning of the list
+    #
+    # @param [Object] item to be added
+    # @return [Array<Object>] list
+    def add_at_beginning(item)
+      list.unshift(*item)
+    end
+
+    # Checks if list have exceeded the max size
+    #
+    # @return [Boolean]
+    def size_exceeded?
+      return false if max_size.zero?
+      list.size > max_size
+    end
+  end
+end

data/lib/silly_list/version.rb

@@ -0,0 +1,3 @@
+module SillyList
+  VERSION = '0.1.0'
+end

data/silly_list.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silly_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'silly_list'
+  spec.version       = SillyList::VERSION
+  spec.authors       = ['SiliconSalad Tech Team']
+  spec.email         = ['tech@siliconsalad.com']
+  spec.summary       = 'Array like classes. Add Stack behavior, Queue is coming.'
+  spec.homepage      = 'https://github.com/siliconsalad/silly_list'
+  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.7'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.2.0'
+  spec.add_development_dependency 'yard'
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'silly_list'

data/spec/uniq_lifo_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+class FakeList < SillyList::UniqLifo
+end
+
+describe SillyList::UniqLifo do
+
+  subject { FakeList.new }
+
+  describe '#empty?' do
+    it 'is empty after creation if we pass nothing to it' do
+      expect(subject.empty?).to eq true
+    end
+
+    it 'is not empty when not empty list is given' do
+      list = subject.class.new([double, double])
+      expect(list.empty?).to eq false
+    end
+
+    it 'is no more empty after an addition' do
+      subject.add(double)
+      expect(subject.empty?).to eq false
+    end
+  end
+
+  describe '#list' do
+    it 'limits size of list at initialization' do
+      limit          = 3
+      list           = [double, double, double, double]
+      uniq_fifo_list = subject.class.new(list, max_size: limit)
+      expect(uniq_fifo_list.list.size).to eq limit
+    end
+
+    it 'does not limit size of the list when max size is not defined' do
+      list           = [double, double, double, double]
+      uniq_fifo_list = subject.class.new(list)
+      expect(uniq_fifo_list.list.size).to eq list.size
+    end
+  end
+
+  describe '#add' do
+    it 'adds an item' do
+      item_1 = double
+      subject.add(item_1)
+      expect(subject.list).to eq([item_1])
+    end
+
+    it 'does not add nil' do
+      subject.add(nil)
+      expect(subject.empty?).to eq(true)
+    end
+
+    it 'adds an array' do
+      arr_1 = [double]
+      subject.add(arr_1)
+      expect(subject.list).to eq(arr_1)
+    end
+
+    it 'adds an object when max size is reached' do
+      limit          = 2
+      list           = [double, double]
+      uniq_fifo_list = subject.class.new(list, max_size: limit)
+      subject.add(double)
+      expect(uniq_fifo_list.list.size).to eq 2
+    end
+
+    it 'adds the last insertion at the first position of the list' do
+      item_1 = double
+      item_2 = double
+      subject.add(item_1)
+      subject.add(item_2)
+      expect(subject.list).to eq([item_2, item_1])
+    end
+
+    context 'item is added twice' do
+      before do
+        @an_item = double
+        subject.add(@an_item)
+        subject.add(@an_item)
+      end
+
+      it 'keeps only one item' do
+        expect(subject.list.count(@an_item)).to eq(1)
+      end
+
+      it 'keeps the last insertion and remove the first' do
+        expect(subject.list.index(@an_item)).to eq(0)
+      end
+    end
+  end
+
+  describe '#remove' do
+    it 'returns the last added item' do
+      item = double
+      subject.add(item)
+      expect(subject.remove).to eq(item)
+    end
+
+    it 'removes the last added item' do
+      item_1 = double
+      item_2 = double
+      subject.add(item_1)
+      subject.add(item_2)
+      subject.remove
+      expect(subject.list).to eq [item_1]
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: silly_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SiliconSalad Tech Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: 
+email:
+- tech@siliconsalad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- ROADMAP.md
+- Rakefile
+- lib/silly_list.rb
+- lib/silly_list/uniq_lifo.rb
+- lib/silly_list/version.rb
+- silly_list.gemspec
+- spec/spec_helper.rb
+- spec/uniq_lifo_spec.rb
+homepage: https://github.com/siliconsalad/silly_list
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Array like classes. Add Stack behavior, Queue is coming.
+test_files:
+- spec/spec_helper.rb
+- spec/uniq_lifo_spec.rb
+has_rdoc: