por_flatten 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5a046e9549106e8fcc07e113f5842549eeb48b32a8e8303fc8d1c83eba45878
+  data.tar.gz: 4c29e5a341109c24878b3ae997f25b53b155631ec4407e25f8c40f416e3eea14
+SHA512:
+  metadata.gz: a720faba147cadc504c9a371c90bfa35805bece16b1bd9daf238967cda353061274ed66b30a72fe546ebf86bebf456c3022e555deb44c4bd39b7823f66636a10
+  data.tar.gz: b0157200b404527cac33c6ca8447520c02fcb07ada1ea56f4eda406eccd6232ddd038c7039932de54ad63a394d4bcbdeb0a1708a46077ced17eb82583d36f8d7

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fxb9500@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in por_flatten.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Xavier Bick
+
+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,54 @@
+# PorFlatten
+
+This gem adds a Plain-Old-Ruby implementation of an array flattening method as `Array#por_flatten`.  Why?  Because `Array#flatten` is implemented in C.
+Disclaimer: Methods used by this gem may be implemented in C.
+
+Serious Disclaimer: This gem is an example.  `Array#flatten`, being written in C, will be theoretically faster than `Array#por_flatten`.  There is really no reason you should be using this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'por_flatten'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install por_flatten
+
+## Usage
+
+__Note__: By default `Array#por_flatten` allows only integer and array elements.  To use this gem with identical functionality to the `Array#flatten` method (minus the ability to specify flattening levels), simply pass in an option like `array.por_flatten(integers_only: false)`
+
+```ruby
+a = [1, 2, [3, 4]]
+a.por_flatten
+=> [1, 2, 3, 4]
+
+b = [['one', 'two',], ['three', 'four']]
+b.por_flatten(integers_only: false)
+=> ['one', 'two', 'three', 'four']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/por_flatten. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PorFlatten project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/por_flatten/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "por_flatten"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/por_flatten.rb

@@ -0,0 +1,90 @@
+require "por_flatten/version"
+
+module PorFlatten
+  class DataTypeError < StandardError; end
+
+  # This method does the flattening.  The approach is keep the number of nested
+  # loops to a minimum by descending all the way into nested arrays immediately
+  # and moving non-array elements to the new results array as they occurr.
+  # We maintain a data "stack" containing the parent array and the index of the
+  # next yet-to-be-processed element.  The loop whitles away at the stack until
+  # no more elements in the root level array remain.
+  #
+  # == Parameters:
+  # +array+::
+  #   [Array] Required.
+  #   The array to flatten.
+  # +integers_only+::
+  #   [Boolean] Required. Default = True
+  #   Whether to allow only integers values, aside from nested arrays.
+  #
+  # == Returns:
+  # An single-level array.
+  #
+  # == Example:
+  # a = [1, 2, [3, 4]]
+  # PorFlatten.flatten(array: a)
+  # => [1, 2, 3, 4]
+  def self.flatten(array:, integers_only: true)
+    # Index for second loop
+    i = 0
+    # Stack of elements to process later (to avoid many nested loops)
+    stack = []
+    # To avoid a while(true) loop, we use stack.length in loop 1.  But we need
+    # a way to detect whether the current iteration is the first one or not.
+    not_run = true
+    # The result we are building.
+    result = []
+
+    # Iterate through the stack.  Since the stack starts empty, we still iterate
+    # if we haven't started yet.
+    while not_run || stack.length > 0
+      # On first run, stack is empty.
+      unless not_run
+        # In the next loop, when an array element is encountered, we start
+        # processing it immediately.  We save the then current array and position
+        # in the stack.  Once an entire non-array-containing element is processed,
+        # we return from the stack to resume the higher-level element at the next
+        # position in the array.
+        array_data = stack.pop
+        i = array_data[:next_index]
+        array = array_data[:array]
+      end
+      not_run = false
+
+      # This loop processes an array, moving the element into the result array or
+      # if the element is another Array, we move the current array and position
+      # into the stack, and start processing the new nested array.
+      while i < array.length
+        element = array[i]
+        i += 1
+
+        if element.instance_of? Array
+          # If in fact the current element is an array, we want to descend into it
+          # so we can move non-array values into the result, but we want to come
+          # back to the remaining elements in the currently processing array, so
+          # we add that array and the current position to the stack.
+          stack << {array: array, next_index: i}
+          array = element
+          i = 0
+        else
+          # Handles the option to disallow non-integer result values.
+          if integers_only && !element.instance_of?(Integer)
+            raise DataTypeError, 'The array element must be either an Integer or an Array'
+          else
+            result << element
+          end
+        end
+      end
+    end
+
+    result
+  end
+end
+
+class Array
+  # We add the +por_flatten+ method to Array instances for ease of use
+  def por_flatten(integers_only: true)
+    PorFlatten.flatten(array: self, integers_only: integers_only)
+  end
+end

data/lib/por_flatten/version.rb

@@ -0,0 +1,3 @@
+module PorFlatten
+  VERSION = "1.0.0"
+end

data/por_flatten.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "por_flatten/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "por_flatten"
+  spec.version       = PorFlatten::VERSION
+  spec.authors       = ["Xavier Bick"]
+  spec.email         = ["fxb9500@gmail.com"]
+
+  spec.summary       = %q{This gem re-implements an Array flatten function in pure Ruby.}
+  spec.homepage      = "https://github.com/zeiv/por_flatten"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: por_flatten
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Xavier Bick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- fxb9500@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/por_flatten.rb
+- lib/por_flatten/version.rb
+- por_flatten.gemspec
+homepage: https://github.com/zeiv/por_flatten
+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.7.8
+signing_key: 
+specification_version: 4
+summary: This gem re-implements an Array flatten function in pure Ruby.
+test_files: []