gist_generator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d3e96fa853bc90250fefed6701af0770286d40eeadaf5e07a6312809b5c3cda
+  data.tar.gz: c23243d350442bdeb80939f2bd10423bf222cf6ec416574e966f983200c152fa
+SHA512:
+  metadata.gz: e0ae3b63a69c7913b07d3eeef618ea238d2a57b4ae64905de011aa30d68c8560e756048397d89728d4314943a8accb2a67811e5d75361228a49aee310ada3531
+  data.tar.gz: 897b20e0d6d5e9e7443970cb477e2d598ec0284e0f8b009b4e3bb20c0959f83eb6f029da07caa7bdf2729ec0e88a89b46a256c9513a8b0ef76a448b1be03d5fe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    gist_generator (0.1.0)
+      faraday (~> 1.0)
+      octokit (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (4.0.5)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  gist_generator!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Santiago Perez Perret
+
+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,39 @@
+# GistGenerator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gist_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gist_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gist_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gist_generator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "gist_generator"
+
+# 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/gist_generator.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gist_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gist_generator"
+  spec.version       = GistGenerator::VERSION
+  spec.authors       = ["Santiago Perez Perret"]
+  spec.email         = ["perezperret@gmail.com"]
+
+  spec.summary       = %q{Create gists by specifying commits, files and line numbers.}
+  spec.description   = %q{Create gists by specifying commits, files and line numbers.}
+  spec.homepage      = "https://github.com/perezperret/gist_generator"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/perezperret/gist_generator"
+  spec.metadata["changelog_uri"] = "https://github.com/perezperret/gist_generator"
+
+  # 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_dependency "octokit", "~> 4.0"
+  spec.add_dependency "faraday", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+end

data/lib/gist_generator.rb

@@ -0,0 +1,30 @@
+require "gist_generator/version"
+require "gist_generator/gist"
+
+require "gist_generator/serializers/json"
+require "gist_generator/serializers/pretty"
+
+module GistGenerator
+  class Error < StandardError; end
+
+  class Generator
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(config)
+      @repo_path = config.fetch(:repo_path)
+      @gists_params = config.fetch(:gists)
+    end
+
+    def call
+      gists_params.map do |params|
+        Gist.new(params.merge(repo_path: repo_path))
+      end
+    end
+
+    private
+
+    attr_reader :gists_params, :repo_path
+  end
+end

data/lib/gist_generator/file.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+require 'octokit'
+
+module GistGenerator
+  class File
+    def initialize(repo_path, file_path, options)
+      @repo_path = repo_path
+      @file_path = file_path
+      @options = options
+    end
+
+    def lines
+      @lines ||= Faraday.get(content.download_url).body.lines
+    end
+
+    def number_of_lines
+      lines.length
+    end
+
+    private
+
+    attr_reader :file_path, :repo_path, :options
+
+    def content
+      client.contents repo_path, path: file_path, query: { ref: ref }
+    end
+
+    def ref
+      commit ? commit.sha : 'master'
+    end
+
+    def commit
+      @commit ||=
+        if commit_message_regex
+          commits.find { |c| c.commit.message.match? commit_message_regex }
+        end
+    end
+
+    def commit_message_regex
+      options[:commit_message_regex]
+    end
+
+    def commits
+      @commits ||= client.commits(repo_path)
+    end
+
+    def client
+      @client ||= Octokit::Client.new
+    end
+  end
+end

data/lib/gist_generator/gist.rb

@@ -0,0 +1,43 @@
+require 'gist_generator/file'
+
+module GistGenerator
+  class Gist
+    def initialize(params)
+      @params = params
+    end
+
+    def lines
+      return file.lines unless line_numbers
+
+      line_numbers.map { |line| file.lines[line - 1] }
+    end
+
+    def line_numbers
+      @line_numbers ||= parsed_line_numbers || all_line_numbers
+    end
+
+    def numbered_lines
+      @numbered_lines ||= line_numbers.zip(lines).to_h
+    end
+
+    def file_number_of_lines
+      file.number_of_lines
+    end
+
+    private
+
+    attr_reader :params
+
+    def file
+      @file ||= File.new(params[:repo_path], params[:file_path], params)
+    end
+
+    def parsed_line_numbers
+      params[:line_numbers]&.map { |n| Array(n) }&.flatten
+    end
+
+    def all_line_numbers
+      Array(1..file.number_of_lines)
+    end
+  end
+end

data/lib/gist_generator/serializers/base.rb

@@ -0,0 +1,27 @@
+module GistGenerator
+  module Serializers
+    class Base
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def initialize(gists)
+        @gists = gists
+      end
+
+      def call
+        gists.map do |gist|
+          {
+            'lines' => gist.lines,
+            'numbered_lines' => gist.numbered_lines,
+            'line_numbers' => gist.line_numbers
+          }
+        end
+      end
+
+      private
+
+      attr_reader :gists
+    end
+  end
+end

data/lib/gist_generator/serializers/json.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'gist_generator/serializers/base'
+
+module GistGenerator
+  module Serializers
+    class JSON < Base
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def initialize(gists)
+        @gists = gists
+      end
+
+      def call
+        { 'gists' => super.to_json }
+      end
+
+      private
+
+      attr_reader :gists
+    end
+  end
+end

data/lib/gist_generator/serializers/pretty.rb

@@ -0,0 +1,47 @@
+require 'gist_generator/serializers/base'
+
+module GistGenerator
+  module Serializers
+    class Pretty
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def initialize(gists, options = {})
+        @gists = gists
+        @options = options
+      end
+
+      def call
+        gists.map { |gist| pretty_print gist }
+      end
+
+      private
+
+      attr_reader :gists, :options
+
+      def pretty_print(gist)
+        result = []
+
+        result << line_separator if gist.line_numbers.first != 1
+
+        gist.line_numbers.each.with_index do |line_number, i|
+          result << gist.numbered_lines[line_number]
+          result << line_separator if needs_separator?(line_number, i, gist)
+        end
+
+        result << line_separator if gist.line_numbers.last != gist.file_number_of_lines
+
+        result
+      end
+
+      def line_separator
+        options.fetch(:line_separator, "# ...\n\n")
+      end
+
+      def needs_separator?(line_number, index, gist)
+        line_number < (gist.line_numbers[index + 1] || gist.line_numbers.last) - 1
+      end
+    end
+  end
+end

data/lib/gist_generator/version.rb

@@ -0,0 +1,3 @@
+module GistGenerator
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: gist_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Santiago Perez Perret
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Create gists by specifying commits, files and line numbers.
+email:
+- perezperret@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gist_generator.gemspec
+- lib/gist_generator.rb
+- lib/gist_generator/file.rb
+- lib/gist_generator/gist.rb
+- lib/gist_generator/serializers/base.rb
+- lib/gist_generator/serializers/json.rb
+- lib/gist_generator/serializers/pretty.rb
+- lib/gist_generator/version.rb
+homepage: https://github.com/perezperret/gist_generator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/perezperret/gist_generator
+  source_code_uri: https://github.com/perezperret/gist_generator
+  changelog_uri: https://github.com/perezperret/gist_generator
+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.6.2
+signing_key: 
+specification_version: 4
+summary: Create gists by specifying commits, files and line numbers.
+test_files: []