arrayie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2219b973f18c45cfda8ea686cc6fcd182bd34cf8
+  data.tar.gz: 33a7d072d339e04ee3b3e8bf2797245f06092865
+SHA512:
+  metadata.gz: 6924996bc8df470d28e8d7f234a2339b1e1cc2613276a2541f52aefad5e1c3d060123247de19cb6a42069960a8cca802faf45f14690f7f867148a38709bd15f5
+  data.tar.gz: 1d42af357d7584ad24bb9d0c1fa80ac50c136eb90c7f2a23e6c6f51d7d2164a312041c93a0d3cd8399098d312fc9ca5977af1b396193f3435acae2c5f907460d

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop', require: false

data/LICENCE

@@ -0,0 +1,15 @@
+Arrayie is a library which contains tools for working with Array in Ruby. 
+Copyright (C) 2017 Hamed Ramezanian Nik
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,65 @@
+# Arrayie
+
+Arrayie is a library which contains tools for working with Array in Ruby. 
+
+## Requirements
+Ruby >= 2.4
+
+## Installation
+
+### RubyGems
+
+Add this to the Gemfile:
+
+    gem 'arrayie'
+
+or install it directly:
+
+    gem install arrayie
+
+### Install from Git
+
+Add the following in the Gemfile:
+
+    gem 'arrayie', :git => 'https://github.com/iCEAGE/arrayie.git'
+
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'arrayie'
+
+array_utils = Arrayie::Tools.new
+
+input_array = [[1, 2, [3]], 4]
+
+flattened_array = array_utils.flatten(input_array)
+
+puts flattened_array
+```
+
+## Tests
+To run the tests:
+````
+bundle exec rake
+````
+
+## License
+
+Copyright (C) 2017 Hamed Ramezanian Nik
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/lib/arrayie/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/arrayie.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/arrayie'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'arrayie'
+  gem.version       = Arrayie::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ['Hamed Ramezanian Nik']
+  gem.email         = ['hamed.r.nik@gmail.com']
+  gem.summary       = 'Arrayie is a library which contains tools for working '\
+    'with Array in Ruby.'
+  gem.description   = 'Arrayie is a library which contains tools for working '\
+    'with Array in Ruby.'
+  gem.homepage      = 'https://github.com/iCEAGE/arrayie'
+  gem.license       = 'LGPL-3.0'
+
+  gem.files         = `git ls-files | grep -Ev '^(myapp|examples)'`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.4'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'minitest', '~> 5.10', '>= 5.10.1'
+end

data/lib/arrayie.rb

@@ -0,0 +1,22 @@
+# Arrayie is a library which contains tools for working with Array in Ruby.
+# Copyright (C) 2017 Hamed Ramezanian Nik
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative 'arrayie/version'
+require_relative 'arrayie/tools'
+
+# This module contains functionality for transforming an Array type
+module Arrayie
+end

data/lib/arrayie/tools.rb

@@ -0,0 +1,37 @@
+# Arrayie is a library which contains tools for working with Array in Ruby.
+# Copyright (C) 2017 Hamed Ramezanian Nik
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Arrayie
+  # This class contains tools for working with Array type
+  class Tools
+    # Flattens a Array type
+    #
+    # @param  [Array] input_array An array
+    # @return [Array] flattened input array
+    # @raise [ArgumentError] if the input array is not an Array type
+    def flatten(input_array)
+      unless input_array.is_a?(Array)
+        raise ArgumentError, 'Accepted input should be an Array type.'
+      end
+
+      input_array.inject([]) do |output_array, item|
+        output_array += item.is_a?(Array) ? flatten(item) : [item]
+
+        output_array
+      end
+    end
+  end
+end

data/lib/arrayie/version.rb

@@ -0,0 +1,20 @@
+# Arrayie is a library which contains tools for working with Array in Ruby.
+# Copyright (C) 2017 Hamed Ramezanian Nik
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Library version
+module Arrayie
+  VERSION = '0.0.1'.freeze unless defined? Arrayie::VERSION
+end

data/test/lib/arrayie/tools_test.rb

@@ -0,0 +1,73 @@
+# Arrayie is a library which contains tools for working with Array in Ruby.
+# Copyright (C) 2017 Hamed Ramezanian Nik
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative '../../test_helper'
+
+class ToolsTest < MiniTest::Test
+  def setup
+    @arrayie_tools = Arrayie::Tools.new
+  end
+
+  def test_flat_an_array_of_integers
+    input_array = [[1, 2, [3]], 4]
+    flattened_array = @arrayie_tools.flatten(input_array)
+    assert_equal flattened_array, [1, 2, 3, 4]
+    assert_equal input_array, [[1, 2, [3]], 4]
+  end
+
+  def test_flat_an_array_of_integers_twice
+    input_array = [[1, 2, [3]], 4]
+    @arrayie_tools.flatten(input_array)
+    flattened_array = @arrayie_tools.flatten(input_array)
+    assert_equal flattened_array, [1, 2, 3, 4]
+    assert_equal input_array, [[1, 2, [3]], 4]
+  end
+
+  def test_flat_an_array_of_strings
+    input_array = ['a', ['b', ['c', []]], 'd']
+    flattened_array = @arrayie_tools.flatten(input_array)
+    assert_equal flattened_array, %w[a b c d]
+    assert_equal input_array, ['a', ['b', ['c', []]], 'd']
+  end
+
+  def test_flat_an_empty_array
+    input_array = []
+    flattened_array = @arrayie_tools.flatten(input_array)
+    assert_equal flattened_array, []
+    assert_equal input_array, []
+  end
+
+  def test_flat_nested_empty_array
+    input_array = [[], [[]], []]
+    flattened_array = @arrayie_tools.flatten(input_array)
+    assert_equal flattened_array, []
+    assert_equal input_array, [[], [[]], []]
+  end
+
+  def test_flat_an_array_with_nil
+    input_array = [[1, 2], nil, [[1], nil], ['string', nil, []]]
+    flattened_array = @arrayie_tools.flatten(input_array)
+    assert_equal flattened_array, [1, 2, nil, 1, nil, 'string', nil]
+    assert_equal input_array, [[1, 2], nil, [[1], nil], ['string', nil, []]]
+  end
+
+  def test_flat_non_array
+    input_array = 'This is wrong!'
+    assert_raises ArgumentError do
+      @arrayie_tools.flatten(input_array)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+# Arrayie is a library which contains tools for working with Array in Ruby.
+# Copyright (C) 2017 Hamed Ramezanian Nik
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative '../lib/arrayie'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: arrayie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hamed Ramezanian Nik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+description: Arrayie is a library which contains tools for working with Array in Ruby.
+email:
+- hamed.r.nik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- arrayie.gemspec
+- lib/arrayie.rb
+- lib/arrayie/tools.rb
+- lib/arrayie/version.rb
+- test/lib/arrayie/tools_test.rb
+- test/test_helper.rb
+homepage: https://github.com/iCEAGE/arrayie
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Arrayie is a library which contains tools for working with Array in Ruby.
+test_files:
+- test/lib/arrayie/tools_test.rb
+- test/test_helper.rb