gemlist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: beee6db7e16d6d5a5f597c0b8b2880c991990690
+  data.tar.gz: 91bc624d56440cf3f9cb81afb388145285bb9759
+SHA512:
+  metadata.gz: 0defa9af278076a6025ba11f7833ffcebb53eacba67be50a87bae710c82bfc8005ce9a9c021c52f4178c0cb63edf1fd74a6f6f911f4bb5ec21891eb1206210f6
+  data.tar.gz: 2d3d7a16b926dfe9459bb4cc6dd30881a8eb2e641bc336f5522f82202a02dbc679626e85c6660291b2b8ada7fb83a90894bce9efe10d46c4cb58e1437263ebbc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require gemlist_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at choffman@optoro.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Hoffman
+
+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.adoc

@@ -0,0 +1,74 @@
+= Gemlist
+
+I built `gemlist` because I wanted a programmatic way to do what http://github.com/samphippen/dundler[dundler] does:
+
+. Figure out what gems would be installed by a given project
+. Give each one a separate `RUN gem install $name -v $version` line in a Dockerfile
+
+I want this capability because a containerization tool I work on builds Docker images from template-generated Dockerfiles, and it'd be nice to not have to wait for `nokogiri` to re-install every time we need to re-containerize a Rails application (as an example).
+
+Given this, I have a very specific set of assumptions:
+
+* I don't care about local (`path => ...`) dependencies.
+* I don't care about git (`git => ...`) dependencies.
+* I do care about being able to include or exclude bundle groups.
+* I don't actually want to install gems, just get a list of them.
+* I have local filesystem access to the Gemfile and Gemfile.lock of the target project.
+
+If these assumptions line up with a problem you're trying to solve, then I hope this saves you time and energy! And, if it does, feel free to contact me, because I'd be interested in hearing about the super-cool thing you're doing with this.
+
+== Use
+
+```ruby
+require 'gemlist'
+
+gemlist = Gemlist.new("/path/to/project")
+
+gemlist.gems.each do |gem|
+  puts "RUN gem install #{gem.name} -v #{gem.version}"
+end
+```
+
+If you want to exclude gem groups, you can do that:
+
+```ruby
+gemlist = Gemlist.new("/path/to/project", without: [:development, :test])
+```
+
+If you want to include addition gem groups, you can do that too:
+
+```ruby
+gemlist = Gemlist.new("/path/to/project", with: [:assets])
+```
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gemlist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gemlist
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 link:https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yarmiganosca/gemlist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the link:http://contributor-covenant.org[Contributer Covenant] code of conduct.
+
+
+== License
+
+The gem is available as open source under the terms of the link:http://opensource.org/licenses/MIT[MIT License].
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gemlist"
+
+# 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

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/gemlist.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gemlist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gemlist"
+  spec.version       = Gemlist::VERSION
+  spec.authors       = ["Chris Hoffman"]
+  spec.email         = ["yarmiganosca@gmail.com"]
+
+  spec.summary       = "Get a list of gems Bundler would install."
+  spec.description   = "Get a list of gems Bundler would install under various conditions. Built to be used in build tools."
+  spec.homepage      = "https://www.github.com/yarmiganosca/gemlist"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+
+  spec.add_runtime_dependency "rubytree", "~> 0.9.7"
+end

data/lib/gemlist.rb

@@ -0,0 +1,59 @@
+require "pathname"
+require "gemlist/version"
+require 'gemlist/group_conflict'
+require "gemlist/spec_tree"
+
+class Gemlist
+  def initialize(path, options = {})
+    @path    = Pathname.new(path)
+    @options = options
+  end
+
+  def gems
+    specs.each.with_index.with_object([]) do |(spec, index), uniquified_specs|
+      last_occurrence_of_spec = specs.rindex(spec) == index
+
+      uniquified_specs << spec if last_occurrence_of_spec
+    end
+  end
+
+  private
+
+  def specs
+    spec_tree = SpecTree.new(path/"Gemfile.lock")
+
+    spec_tree
+      .depth_first_children_first
+      .reject(&:is_root?)
+      .select { |node| node.descends_from?(*top_level_dependencies) }
+      .map(&:content)
+  end
+
+  def top_level_dependencies
+    bundle_definition
+      .dependencies
+      .select { |dependency| (dependency.groups & groups).any? }
+  end
+
+  def bundle_definition
+    return @bundle_definition unless @bundle_definition.nil?
+
+    builder = Bundler::Dsl.new
+    builder.eval_gemfile(path/"Gemfile")
+
+    @bundle_definition = builder.to_definition(path/"Gemfile.lock", {})
+  end
+
+  def groups
+    excluded_groups = options.fetch(:without) { [] }
+    included_groups = options.fetch(:with) { [] }
+
+    intersection    = excluded_groups & included_groups
+
+    raise GroupConflict.new(*intersection) if intersection.any?
+
+    bundle_definition.groups + included_groups - excluded_groups
+  end
+
+  attr_reader :path, :options
+end

data/lib/gemlist/group_conflict.rb

@@ -0,0 +1,7 @@
+class Gemlist
+  class GroupConflict < StandardError
+    def initialize(*group_names)
+      super "The groups #{group_names} were both excluded from and included in the gemlist."
+    end
+  end
+end

data/lib/gemlist/spec_node.rb

@@ -0,0 +1,33 @@
+require 'tree'
+
+class Gemlist
+  class SpecNode < Tree::TreeNode
+    def total_dependency_count
+      size - 1
+    end
+
+    def depth_first_children_first
+      sorted_children = children.sort_by(&:total_dependency_count)
+      parent          = self
+
+      Enumerator.new do |yielder|
+        sorted_children.each do |child|
+          child.depth_first_children_first.each do |node|
+            yielder << node
+          end
+        end
+
+        yielder << parent
+      end
+    end
+
+    def lineage
+      [self, *parentage].reverse.reject(&:is_root?)
+    end
+
+    def descends_from?(*dependencies)
+      !is_root? &&
+        dependencies.map(&:name).include?(lineage.first.name)
+    end
+  end
+end

data/lib/gemlist/spec_tree.rb

@@ -0,0 +1,42 @@
+require 'bundler'
+require 'gemlist/spec_node'
+
+class Gemlist
+  class SpecTree < SpecNode
+    def initialize(lockfile)
+      lockfile_parser = Bundler::LockfileParser.new(lockfile.read)
+
+      super("root", lockfile_parser)
+
+      specs_to_place = lockfile_parser.specs.to_set
+
+      # start with the top-level declared dependencies
+      lockfile_parser.dependencies.each do |dependency|
+        spec_for_dependency = specs_to_place.find { |spec| spec.name == dependency.name }
+
+        self << SpecNode.new(spec_for_dependency.name, spec_for_dependency)
+
+        specs_to_place.delete(spec_for_dependency)
+      end
+
+      until specs_to_place.empty?
+        specs_to_place.each do |spec|
+          # we find all the specs that are parent to this one, so that we can
+          # just remove entire top-level branches when it comes time to exclude
+          # groups
+          parent_nodes = select do |node|
+            node.content.dependencies.any? do |dependency|
+              dependency.name == spec.name
+            end
+          end
+
+          parent_nodes.each do |node|
+            node << SpecNode.new(spec.name, spec)
+          end
+
+          specs_to_place.delete(spec) if parent_nodes.any?
+        end
+      end
+    end
+  end
+end

data/lib/gemlist/version.rb

@@ -0,0 +1,3 @@
+class Gemlist
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: gemlist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hoffman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+description: Get a list of gems Bundler would install under various conditions. Built
+  to be used in build tools.
+email:
+- yarmiganosca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- gemlist.gemspec
+- lib/gemlist.rb
+- lib/gemlist/group_conflict.rb
+- lib/gemlist/spec_node.rb
+- lib/gemlist/spec_tree.rb
+- lib/gemlist/version.rb
+homepage: https://www.github.com/yarmiganosca/gemlist
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Get a list of gems Bundler would install.
+test_files: []