networkx 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 075600936b353d065030ac10f584289ef859051b
+  data.tar.gz: 24ee821d52b51dd5d4c4c90fa07f06ed3d0e8218
+SHA512:
+  metadata.gz: e1c43f90d1f537e034b131f2329a55462cf2b58829c6cfc0213ab9b25a1ba6261885e8e1a9799934a91a43565e2f18623909e39bd21c02bb58745d30192fb33f
+  data.tar.gz: c1ad69746300bd9bbfc69a8b8aa95ca38e0743835c8883cda82a7e3d0433d1df2e619358044fa00155c78a991da5906c42b5b626c8ed8905e3d8903c68f323c7

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle/
+.yardoc/
+Gemfile.lock
+/_yardoc/
+*.DS_store
+.rspec_status
+coverage/
+dump.rdb
+doc/
+docs/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rspec_formatter.rb

@@ -0,0 +1,24 @@
+RSpec::Support.require_rspec_core 'formatters/base_text_formatter'
+
+class SimpleFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register self,
+    :example_passed, :example_pending, :example_failed, :dump_pending, :dump_failures, :dump_summary
+
+  def example_passed(message); end
+
+  def example_pending(message); end
+
+  def example_failed(message); end
+
+  def dump_pending(message); end
+
+  def dump_failures(message); end
+
+  def dump_summary(message)
+    colorizer = ::RSpec::Core::Formatters::ConsoleCodes
+
+    output.puts "\nFinished in #{message.formatted_duration} " \
+       "(files took #{message.formatted_load_time} to load)\n" \
+       "#{message.colorized_totals_line(colorizer)}\n"
+  end
+end

data/.rubocop.yml

@@ -0,0 +1,109 @@
+require: rubocop-rspec
+
+AllCops:
+  Include:
+    - 'lib/**/*'
+  Exclude:
+    - 'vendor/**/*'
+    - 'benchmarks/*'
+    - 'profile/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.1
+
+# Preferred codebase style ---------------------------------------------
+
+### Layouts ------------------------------------------------------------
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Layout/SpaceAfterComma:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+### Styles -------------------------------------------------------------
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/EmptyMethod:
+  EnforcedStyle: compact
+
+Style/FileName:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false # TODO
+
+### Metrics ------------------------------------------------------------
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Max: 200
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 10
+
+### RSpec --------------------------------------------------------------
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/NestedGroups:
+  Max: 5

data/.travis.yml

@@ -0,0 +1,18 @@
+language:
+  ruby
+
+rvm:
+  - '2.1'
+  - '2.2'
+  - '2.3.0'
+  - '2.4.0'
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+
+install:
+  - gem install bundler
+  - gem install rainbow -v '2.2.1'
+  - sudo apt-get update -qq
+  - bundle install

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--markup-provider redcarpet

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 athityakumar@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contribution guidelines
+
+First of all, thanks for thinking of contributing to this project. :smile:
+
+Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.
+
+- If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
+- If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.
+
+Please proceed with a Pull Request only after you're assigned. It'd be sad if your Pull Request (and your hardwork) isn't accepted just because it isn't idealogically compatible.
+
+# Developing the gem
+
+1. Clone this repository and install all the required gem dependencies.
+
+    ```sh
+    git clone https://github.com/athityakumar/daru-io.git
+    cd daru-io
+    gem install bundler
+    bundle install
+    ```
+
+2. Checkout to a different git branch (say, `adds-new-feature`).
+
+3. Add any gem dependencies required, appropriately to the gemspec file or Gemfile.
+
+4. Add code and YARD documentation.
+
+5. Add tests to `spec/networkx/filename_spec.rb`. Add any files required for testing in the `spec/fixtures/` directory.
+
+6. Run the rspec test-suite.
+    ```sh
+    # Runs test suite for all files
+    bundle exec rspec
+
+    # Runs test-suite only for a particular file
+    bundle exec rspec spec/networkx/filename_spec.rb
+    ```
+
+7. Run the rubocop for static code quality comments.
+
+    ```sh
+    # Runs rubocop test for all files
+    bundle exec rubocop
+
+    # Runs rubocop test only for a particular file
+    bundle exec rubocop lib/networkx/filename.rb
+    ```
+
+8. Send a Pull Request back to this repository. :tada:

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/networkx/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { 'spec' }
+end
+
+# TODO: Run Rubocop in the background

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 [Athitya Kumar](https://github.com/athityakumar/).
+
+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,57 @@
+# NetworkX.rb
+
+[NetworkX](https://networkx.github.io/) is a very popular Python library, that handles various use-cases of the Graph Data Structure. This project intends to provide a working alternative to the Ruby community, by closely mimicing as many features as possible. 
+
+*This project has begun just now, and a v0.1.0 release with basic Graph classes can be expected by January 2018.*
+
+### List of contents
+
+- [Installing](#installing)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [License](#license)
+
+### Installing
+
+[(Back to top)](#list-of-contents)
+
+- Clone the repository with `git clone git@github.com:athityakumar/networkx.rb.git`
+- Navigate to networkx with `cd networkx.rb`
+- Install dependencies with `gem install bundler && bundle install`
+- Install networkx gem with `rake install`
+- Start checking out in PRY / IRB console : 
+
+```ruby
+require 'networkx'
+#=> true
+
+# Yet to be implemented
+g = NetworkX::Graph.new()
+g.add_edge('start', 'stop')
+``` 
+
+### Roadmap
+
+[(Back to top)](#list-of-contents)
+
+Quite easily, any networkx user would be able to understand the number of details that have been implemented in the Python library. As a humble start towards the release of v0.1.0, the following could be the goals to achieve :
+
+- `Node` : This class should be capable of handling different types of nodes (not just `String` / `Integer`). A possible complex use-case could be XML nodes.
+
+- `Edge` : This class should be capable of handling different types of edges. Though a basic undirected Graph doesn't store any metadata in the edges, weighted edges and parametric edges are something that need to be handled.
+
+- `Graph` : The simplest of graphs. This class handles just connections between different `Node`s via `Edge`s.
+
+- `DirectedGraph` : Inherits from `Graph` class. Uses directions between `Edge`s.
+
+### Contributing
+
+[(Back to top)](#list-of-contents)
+
+Your contributions are always welcome! Please have a look at the [contribution guidelines](CONTRIBUTING.md) first. :tada:
+
+### License
+
+[(Back to top)](#list-of-contents)
+
+The MIT License 2017 - [Athitya Kumar](https://github.com/athityakumar). Please have a look at the [LICENSE.md](LICENSE.md) for more details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %w[spec rubocop]

data/lib/networkx.rb

@@ -0,0 +1 @@
+require 'networkx/version'

data/lib/networkx/version.rb

@@ -0,0 +1,3 @@
+module NetworkX
+  VERSION = '0.0.0'.freeze
+end

data/networkx.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'networkx/version'
+
+NetworkX::DESCRIPTION = <<MSG.freeze
+  A Ruby implemenation of the well-known graph library called "networkx".
+MSG
+
+Gem::Specification.new do |spec|
+  spec.name          = 'networkx'
+  spec.version       = NetworkX::VERSION
+  spec.authors       = ['Athitya Kumar']
+  spec.email         = ['athityakumar@gmail.com']
+  spec.summary       = 'A Ruby implemenation of the well-known graph library called networkx.'
+  spec.description   = NetworkX::DESCRIPTION
+  spec.homepage      = 'https://github.com/athityakumar/networkx.rb'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop', '>= 0.40.0'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubygems-tasks'
+  spec.add_development_dependency 'saharspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
+
+  spec.add_development_dependency 'guard-rspec' if RUBY_VERSION >= '2.2.5'
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: networkx
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Athitya Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: redcarpet
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: rubygems-tasks
+  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: saharspec
+  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: simplecov
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: |2
+    A Ruby implemenation of the well-known graph library called "networkx".
+email:
+- athityakumar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec_formatter.rb"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/networkx.rb
+- lib/networkx/version.rb
+- networkx.gemspec
+homepage: https://github.com/athityakumar/networkx.rb
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A Ruby implemenation of the well-known graph library called networkx.
+test_files: []