falkor 0.1.0

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 npezza93@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,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem "pry"
+gem "rubocop"
+gem "rubocop-performance"
+gem "simplecov"
+gem "vcr"
+gem "webmock"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nick Pezza
+
+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,61 @@
+<p align="center">
+  <a href="https://github.com/npezza93/falkor">
+    <img src="./.github/logo.jpg" width="350">
+  </a>
+</p>
+
+
+# Falkor
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'falkor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install falkor
+
+## Usage
+
+
+#### Ruby Core and Stlib
+
+```ruby
+store = Falkor::Ruby.new(version).generate do |action, progress, description|
+  puts action, progress, description
+end
+```
+
+#### Remote Gem
+
+```ruby
+store = Falkor::Gem.new(name, version: (optional)).generate do |action, progress, description|
+  puts action, progress, description
+end
+```
+
+## 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/npezza93/falkor. 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 Falkor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/npezza93/falkor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "falkor"
+require "pry"
+
+def reload!
+  puts "Reloading..."
+  old_verbose = $VERBOSE
+  $VERBOSE = nil
+
+  $LOADED_FEATURES.select { |feat| feat =~ /\/falkor\// }.each(&method(:load))
+
+  $VERBOSE = old_verbose
+  true
+end
+
+Pry.start

data/bin/publish

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+require "fileutils"
+require_relative "../lib/falkor/version"
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path("..", __dir__)
+MASTER_CHECK = <<~MASTER_CHECK
+  if [ $(git symbolic-ref --short -q HEAD) != 'master' ];
+    then exit 1;
+  fi
+MASTER_CHECK
+VERSION_TYPES = %w(major minor patch).freeze
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+abort("\n== Version Type incorrect ==") unless VERSION_TYPES.include?(ARGV[0])
+
+abort("\n== Not on master") unless system(MASTER_CHECK)
+
+current_version = Falkor::VERSION.split(".").map(&:to_i)
+
+case ARGV[0]
+when "major"
+  current_version[0] += 1
+  current_version[1] = 0
+  current_version[2] = 0
+when "minor"
+  current_version[1] += 1
+  current_version[2] = 0
+when "patch"
+  current_version[2] += 1
+end
+
+joined_version = current_version.join(".")
+
+FileUtils.chdir APP_ROOT do
+  contents = <<~FILE
+    # frozen_string_literal: true
+
+    module Falkor
+      VERSION = "#{joined_version}"
+    end
+  FILE
+
+  puts "== Updating version to #{joined_version} =="
+  File.write("lib/falkor/version.rb", contents)
+
+  system! "git add lib/falkor/version.rb"
+
+  puts "== Committing updated files =="
+  system! "git commit -m 'Version bump to #{joined_version}'"
+  system! "git push"
+
+  puts "== Publishing gem =="
+  system! "bundle exec rake release"
+  built_gem_path = "pkg/falkor-#{joined_version}.gem"
+  github_host = "https://rubygems.pkg.github.com/npezza93"
+
+  system! "gem push --key github --host #{github_host} #{built_gem_path}"
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "falkor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "falkor"
+  spec.version       = Falkor::VERSION
+  spec.authors       = "Nick Pezza"
+  spec.email         = "npezza93@gmail.com"
+  spec.license       = "MIT"
+  spec.summary       = %q(A parser that Just Works)
+
+  spec.homepage      = "https://github.com/npezza93/falkor"
+  spec.metadata["github_repo"] = "ssh://github.com/npezza93/falkor"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] =
+    "https://github.com/npezza93/falkor/releases"
+
+  spec.require_path  = "lib"
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  end
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency             "gems",     "~> 1.1"
+  spec.add_dependency             "yard",     "< 0.10.0"
+
+  spec.add_development_dependency "bundler", ">= 1.17", "< 3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/lib/falkor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "falkor/version"
+
+require "falkor/download"
+
+require "falkor/extract/gem"
+require "falkor/extract/tar_gz"
+
+require "falkor/yard/documentation"
+
+require "falkor/ruby"
+require "falkor/gem"
+
+module Falkor
+end

data/lib/falkor/concerns/installable.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Falkor
+  module Installable
+    def download
+      return yard_filepath if Dir.exist? yard_filepath
+
+      block =
+        if block_given?
+          Proc.new
+        else
+          proc {}
+        end
+
+      generate_documentation(extract(download_source(&block), &block), &block)
+    end
+
+    private
+
+    def download_source
+      Falkor::Download.new(url, file_name).download do |progress|
+        yield :downloading, progress
+      end
+    end
+
+    def extract(file_path)
+      Falkor::Extract::TarGz.
+        new(file_path, has_root_dir: true).
+        extract do |progress|
+          yield :extracting, progress
+        end
+    end
+
+    def generate_documentation(file_path)
+      Falkor::Yard::Documentation.
+        new(file_path, yard_filepath).
+        generate do |progress, description|
+          yield :generating, progress, description
+        end
+    end
+
+    def store
+      @store ||= begin
+        reg_store = YARD::RegistryStore.new
+        reg_store.load(download)
+        reg_store
+      end
+    end
+  end
+end

data/lib/falkor/concerns/trackable_progress.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "falkor/progress"
+
+module Falkor
+  module TrackableProgress
+    def report_progress(method_to_run, total, *args)
+      progress = Progress.new(total)
+      send(method_to_run, *args) do |amount, description = nil|
+        progress.increment!(amount, description, &Proc.new)
+      end
+    end
+  end
+end

data/lib/falkor/download.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "falkor/concerns/trackable_progress"
+
+module Falkor
+  class Download
+    include TrackableProgress
+
+    def initialize(url, file_name)
+      @url = url
+      @file_name = file_name
+    end
+
+    def download
+      return destination if File.exist?(destination)
+
+      request do |response, file_size|
+        next unless success?(response)
+
+        report_progress(:write_chunks, file_size, response, &Proc.new)
+        destination
+      end
+    end
+
+    private
+
+    attr_reader :url, :file_name
+
+    def request
+      return_value = nil
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: https?) do |http|
+        http.request(Net::HTTP::Get.new(uri)) do |response|
+          return_value = yield response, response["content-length"].to_i
+        end
+      end
+
+      return_value
+    end
+
+    def uri
+      @uri ||= URI(url)
+    end
+
+    def https?
+      uri.scheme == "https"
+    end
+
+    def write_chunks(response)
+      FileUtils.mkdir_p "tmp"
+      FileUtils.rm_rf destination
+
+      File.open(destination, "wb") do |file|
+        response.read_body do |chunk|
+          file.write chunk
+
+          yield(chunk.size)
+        end
+      end
+    end
+
+    def success?(response)
+      (200..299).cover?(response.code.to_i)
+    end
+
+    def destination
+      File.join(Dir.pwd, "tmp", file_name)
+    end
+  end
+end