gem_metadata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 814ea53e8508af95ce950b9c33c2a07ff3b1982e
+  data.tar.gz: d8837a3c9bbfc40aa516162caaaa5b6702099075
+SHA512:
+  metadata.gz: 546b1a9085467507a6ada041968f25f1feb32aab99258ad6975c972a1a97ace3dcb1096dc756394e8e226f15a23e4c7fcc796f34223748239d4389fa53d0e335
+  data.tar.gz: 313cc96c897ead14b33437ee95c68b82bb59c8a098c08ddc679f49cca11241f947486b549c1777eb43b4ef4ac1fe3ca32e7292ca5b87a48ae5c2b481a39eba4a

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+# Project metadata
+/nbproject
+/.idea
+
+/Gemfile.lock
+
+/doc/api
+/coverage
+/pkg
+/.yardoc
+.rbx
+*.rbc

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order random
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - rbx-2
+  - jruby-19mode

data/.yardopts

@@ -0,0 +1,9 @@
+--output-dir=doc/api
+--embed-mixins
+--protected
+--no-private
+--markup-provider=kramdown
+--markup=markdown
+-
+HISTORY.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of GemMetadata.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+source 'https://rubygems.org'
+
+# Gem dependencies are specified in the .gemspec file
+gemspec
+
+gem 'coveralls', require: false

data/HISTORY.md

@@ -0,0 +1,6 @@
+0.1.0 / 2016-09-06
+==================
+
+* 1 major enhancement
+
+  * Birthday!

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+GemMetadata is licensed under the following ISC-style license:
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,217 @@
+GemMetadata
+===========
+
+[![Gem Version](https://badge.fury.io/rb/gem_metadata.png)](https://badge.fury.io/rb/gem_metadata)
+[![Dependency Status](https://gemnasium.com/godobject/gem_metadata.png)](https://gemnasium.com/godobject/gem_metadata)
+[![Code Climate](https://codeclimate.com/github/godobject/gem_metadata.png)](https://codeclimate.com/github/godobject/gem_metadata)
+[![Build Status](https://secure.travis-ci.org/godobject/gem_metadata.png)](https://secure.travis-ci.org/godobject/gem_metadata)
+[![Coverage Status](https://coveralls.io/repos/github/godobject/gem_metadata/badge.svg?branch=master)](https://coveralls.io/github/godobject/gem_metadata?branch=master)
+
+* [Documentation][docs]
+* [Project][project]
+
+   [docs]:    http://rdoc.info/github/godobject/gem_metadata/
+   [project]: https://github.com/godobject/gem_metadata/
+
+Description
+-----------
+
+GemMetadata is a Ruby library that allows to filter and access gems by custom
+metadata keys that their specifications contain.
+
+Features / Problems
+-------------------
+
+This project tries to conform to:
+
+* [Semantic Versioning (2.0.0)][semver]
+* [Ruby Packaging Standard (0.5-draft)][rps]
+* [Ruby Style Guide][style]
+* [Gem Packaging: Best Practices][gem]
+
+   [semver]: http://semver.org/spec/v2.0.0.html
+   [rps]:    http://chneukirchen.github.com/rps/
+   [style]:  https://github.com/bbatsov/ruby-style-guide
+   [gem]:    http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
+
+Additional facts:
+
+* Written purely in Ruby.
+* Documented with Cucumber.
+* Automatically testable through Cucumber and RSpec.
+* Intended to be used with Ruby 2.3.0 or higher.
+* Cryptographically signed git tags.
+
+Requirements
+------------
+
+* Ruby 2.3.0 or higher
+
+Installation
+------------
+
+On *nix systems you may need to prefix the command with `sudo` to get root
+privileges.
+
+### Gem
+
+    gem install gem_metadata
+
+### Automated testing
+
+Go into the root directory of the installed gem and run the following command
+to fetch all development dependencies:
+
+    bundle
+
+Afterwards start the test runner:
+
+    rake test
+
+If something goes wrong you should be notified through failing examples.
+
+Usage
+-----
+
+This documentation defines the public interface of the software. The version
+number of the software tracks changes to this public interface as described in
+[Semantic Versioning][semver]. Do not use elements that are marked as private.
+These elements are not guaranteed to exist in otherwise compatible future
+versions. Should you really need some parts that are currently marked as
+private, please contact us. We might be able to expose them as public
+interface for your convenience.
+
+This is still experimental software, even the public interface may change
+substantially in future releases.
+
+   [semver]: http://semver.org/spec/v2.0.0.html
+
+### Ruby interface
+
+#### Loading
+
+In most cases you want to load the code by using the following command:
+
+~~~~~ ruby
+require 'gem_metadata'
+~~~~~
+
+In a bundler Gemfile you should use the following:
+
+~~~~~ ruby
+gem 'gem_metadata'
+~~~~~
+
+#### Namespace
+
+This project is contained within a namespace to avoid name collisions with
+other code. If you do not want to specifiy the namespace explicitly you can
+include it into the current scope by executing the following statement:
+
+~~~~~ ruby
+include GodObject::GemMetadata
+~~~~~
+
+Development
+-----------
+
+### Bug reports and feature requests
+
+Please use the [issue tracker][issues] on github.com to let me know about errors
+or ideas for improvement of this software.
+
+   [issues]: https://github.com/godobject/gem_metadata/issues/
+
+### Source code
+
+#### Distribution
+
+This software is developed in the source code management system Git. There are
+several synchronized mirror repositories available:
+
+* [GitHub][github] (located in California, USA)
+    
+    URI: https://github.com/godobject/gem_metadata.git
+
+* [GitLab][gitlab] (located in Illinois, USA)
+    
+    URI: https://gitlab.com/godobject/gem_metadata.git
+
+* [BitBucket][bitbucket] (located in California, USA)
+    
+    URI: https://bitbucket.org/godobject/gem_metadata.git
+
+* [Pikacode][pikacode] (located in France)
+
+    URI: https://pikacode.com/godobject/gem_metadata.git
+
+   [github]:    https://github.com/godobject/gem_metadata/
+   [gitlab]:    https://gitlab.com/godobject/gem_metadata/
+   [bitbucket]: https://bitbucket.org/godobject/gem_metadata/
+   [pikacode]:  https://pikacode.com/godobject/gem_metadata/
+
+You can get the latest source code with the following command, while
+exchanging the placeholder for one of the mirror URIs:
+
+    git clone MIRROR_URI
+
+#### Tags and cryptographic verification
+
+The final commit before each released gem version will be marked by a tag
+named like the version with a prefixed lower-case "v". Every tag will be signed
+by Alexander E. Fischer's [OpenPGP public key][openpgp] which enables you to
+verify your copy of the code cryptographically.
+
+   [openpgp]: https://aef.name/crypto/aef-openpgp.asc
+
+Add the key to your GnuPG keyring by the following command:
+
+    gpg --import aef-openpgp.asc
+
+This command will tell you if your code is of integrity and authentic:
+
+    git tag --verify [TAG NAME]
+
+#### Building gems
+
+To package your state of the source code into a gem package use the following
+command:
+
+    rake build
+
+The gem will be generated according to the .gemspec file in the project root
+directory and will be placed into the pkg/ directory.
+
+### Contribution
+
+Help on making this software better is always very appreciated. If you want
+your changes to be included in the official release, please clone the project
+on github.com, create a named branch to commit, push your changes into it and
+send a pull request afterwards.
+
+Please make sure to write tests for your changes so that no one else will break
+them when changing other things. Also notice that an inclusion of your changes
+cannot be guaranteed before reviewing them.
+
+The following people were involved in development:
+
+* Alexander E. Fischer <aef@godobject.net>
+
+License
+-------
+
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of GemMetadata.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/Rakefile

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of GemMetadata.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'pathname'
+require 'yard'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new
+Cucumber::Rake::Task.new
+
+desc 'Run RSpec code examples and Cucumber features'
+task test: [:spec, :cucumber]
+
+YARD::Rake::YardocTask.new('doc')
+
+desc 'Removes temporary project files'
+task :clean do
+  %w(doc/api coverage pkg .yardoc .rbx Gemfile.lock).map{ |name| Pathname.new(name) }.each do |path|
+    path.rmtree if path.exist?
+  end
+
+  Pathname.glob('*.gem').each(&:delete)
+  Pathname.glob('**/*.rbc').each(&:delete)
+end
+
+desc 'Opens an interactive console with the project code loaded'
+task :console do
+  Bundler.setup
+  require 'pry'
+  require 'gem_metadata'
+  Pry.start(GodObject::GemMetadata)
+end
+
+task default: :test

data/features/finding_gems_with_matching_metadata.feature

@@ -0,0 +1,55 @@
+Feature: Finding gems with matching metadata
+
+  Scenario: Two gem dependencies without matching metadata
+    Given a dependency to a gem called "first_without_metadata" without metadata
+    And a dependency to a gem called "second_without_metadata" without metadata
+    When the following code is executed:
+    """
+    require 'gem_metadata'
+
+    metadata_service = GodObject::GemMetadata::Service.new
+
+    metadata_service.find_gems_providing('some key')
+    """
+    Then the result lists none of the gems
+
+  Scenario: One gem dependency with matching metadata and one without
+    Given a dependency to a gem called "with_metadata" with the following metadata definition in its gemspec:
+    """
+      gem.metadata = {
+        'some key' => 'some value'
+      }
+    """
+    And a dependency to a gem called "without_metadata" without metadata
+    When the following code is executed:
+    """
+    require 'gem_metadata'
+
+    metadata_service = GodObject::GemMetadata::Service.new
+    
+    metadata_service.find_gems_providing('some key')
+    """
+    Then the result lists solely the gem named "with_metadata"
+
+  Scenario: Two gem dependencies without matching metadata
+    Given a dependency to a gem called "first_with_metadata" with the following metadata definition in its gemspec:
+    """
+      gem.metadata = {
+        'some key' => 'some value'
+      }
+    """
+    And a dependency to a gem called "second_with_metadata" with the following metadata definition in its gemspec:
+    """
+      gem.metadata = {
+        'some key' => 'other value'
+      }
+    """
+    When the following code is executed:
+    """
+    require 'gem_metadata'
+
+    metadata_service = GodObject::GemMetadata::Service.new
+
+    metadata_service.find_gems_providing('some key')
+    """
+    Then the result lists the gems named "first_with_metadata" and "second_with_metadata"

data/features/step_definitions/steps.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+=begin
+Copyright Alexander E. Fischer <aef@godobject.net>, 2016
+
+This file is part of GemMetadata.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+Given(/^a dependency to a gem called "([^"]*)" with the following metadata definition in its gemspec:$/) do |gem_name, gem_metadata_definition|
+  gemspec_content = gemspec_for(gem_name: gem_name, additional_content: gem_metadata_definition)
+
+  create_gem_dependency(name: gem_name, gemspec_content: gemspec_content)
+end
+
+Given(/^a dependency to a gem called "([^"]*)" without metadata$/) do |gem_name|
+  create_gem_dependency(name: gem_name)
+end
+
+When(/^the following code is executed:$/) do |code_to_execute|
+  create_gemfile(include_gems: gem_dependencies)
+
+  code_file = write_code_as_function_into_file(code_to_execute)
+
+  evaluate_in_separate_environment("bundle exec ruby -r'#{code_file}' -e 'puts Marshal.dump(code_to_execute)'")
+end
+
+Then(/^the result lists none of the gems$/) do
+  expect(evaluation_result).to eql []
+end
+
+Then(/^the result lists solely the gem named "([^"]*)"$/) do |gem_name|
+  expect(evaluation_result).to have(1).item
+  expect(evaluation_result.first).to be_a Gem::Specification
+  expect(evaluation_result.first.name).to eql gem_name
+end
+
+Then(/^the result lists the gems named "([^"]*)" and "([^"]*)"$/) do |first_gem_name, second_gem_name|
+  expect(evaluation_result).to have(2).items
+  expect(evaluation_result[0]).to be_a Gem::Specification
+  expect(evaluation_result[0].name).to eql first_gem_name
+  expect(evaluation_result[1]).to be_a Gem::Specification
+  expect(evaluation_result[1].name).to eql second_gem_name
+end