script_ripper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 987b360a4e6447333e064b4a449a0aa6a300efd512a9a4028311615cc106721f
+  data.tar.gz: 0f5892b689a3798f828434f8e9a87c389a0dceafe97f2f055a8c34f5c91d4d57
+SHA512:
+  metadata.gz: 5b7cf963825db3ed3802731fec4a27511a52d8f7b86abde2dfa568bf0c200ca5127aa9536e137782737dd9f5a11c22f21215616a494a26e9ae23303d78c77fa9
+  data.tar.gz: 917cec678062943ae00ccca24a0859d84c4ac4b439e1b9825ff1231b31bce0490cbf62b6395d5f0fb1bf17c7606cf78a298760ed7540ea990d402cff4f52e0b2

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in script_ripper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    script_ripper (0.1.0)
+      nokogiri (~> 1.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    hashdiff (1.0.1)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    minitest (5.16.3)
+    mocha (1.14.0)
+    nokogiri (1.13.8-arm64-darwin)
+      racc (~> 1.4)
+    public_suffix (5.0.0)
+    racc (1.6.0)
+    rake (13.0.6)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bundler (~> 2.3)
+  debug (~> 1.6)
+  minitest (~> 5.16)
+  mocha (~> 1.14)
+  rake (~> 13.0)
+  script_ripper!
+  vcr (= 6.1.0)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dave Benvenuti
+
+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 @@
+# Script::Ripper
+
+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/script/ripper`. 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 'script_ripper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install script_ripper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/script_ripper.
+
+## 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,10 @@
+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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "script_ripper"
+
+# 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/exe/script_ripper

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "script_ripper/cli"
+
+ScriptRipper::CLI.call

data/lib/script_ripper/cli.rb

@@ -0,0 +1,94 @@
+require "optparse"
+
+require "script_ripper/downloader"
+require "script_ripper/parser"
+require "script_ripper/script_writer"
+
+module ScriptRipper
+  class CLI
+    attr_reader :arguments, :options, :url, :group_name
+
+    def initialize(arguments = ARGV)
+      @arguments = arguments
+      @options = {}
+    end
+
+    def call
+      parse_arguments!
+
+      content = Downloader.call(url)
+      code_blocks = Parser.call(content, group_by: group_by)
+
+      if code_blocks.is_a?(Hash)
+        ScriptWriter.call(code_blocks: code_blocks[group_name], from_url: url, group_name: group_name)
+      else
+        ScriptWriter.call(code_blocks: code_blocks, from_url: url)
+      end
+    end
+
+    class << self
+      def call(arguments = ARGV)
+        new(arguments).call
+      end
+    end
+
+    def group_by
+      options[:"group-by"]
+    end
+
+    private
+
+    attr_reader :option_parser
+
+    def parse_arguments!
+      @option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: script_ripper [options] URL [group_name]"
+
+        opts.on(
+          "-g GROUPBY",
+          "--group-by GROUPBY",
+          "Group by an element type (typically something like h2, h3, etc.  Required if group_name is provided."
+        )
+
+        opts.on("-h", "--help", "Show this message")
+
+        opts.parse!(arguments, into: options)
+      end
+
+      if options["help"]
+        puts option_parser
+        exit 0
+      end
+
+      # opts.parse! is destructive, so whatever remains should be the URL and optional group name
+      @url, @group_name = arguments
+
+      print_usage_and_exit_if_arguments_invalid!
+    end
+
+    def print_usage_and_exit_if_arguments_invalid!
+      fail! if blank?(url)
+
+      return if blank?(group_by) && blank?(group_name)
+      return if present?(group_by) && present?(group_name)
+
+      fail!
+    end
+
+    def fail!
+      puts option_parser
+      exit 1
+    end
+
+    def present?(value)
+      return false if value.nil?
+      return false if value.respond_to?(:empty?) && value.empty?
+
+      true
+    end
+
+    def blank?(value)
+      !present?(value)
+    end
+  end
+end

data/lib/script_ripper/code_block.rb

@@ -0,0 +1,21 @@
+module ScriptRipper
+  class CodeBlock
+    attr_reader :description, :code, :nokogiri_list_item
+
+    def initialize(description:, code:, nokogiri_list_item: nil)
+      @description = description.chomp
+      @code = code.chomp
+      @nokogiri_list_item = nokogiri_list_item
+    end
+
+    def inspect
+      { "description" => description, "code" => code }.inspect
+    end
+
+    def ==(other_code_block)
+      return false unless other_code_block.is_a?(CodeBlock)
+
+      description == other_code_block.description && code == other_code_block.code
+    end
+  end
+end

data/lib/script_ripper/downloader.rb

@@ -0,0 +1,25 @@
+require "open-uri"
+
+module ScriptRipper
+  class Downloader
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def call
+      StringIO.new.tap { |content|
+        URI.open(url) do |remote_content|
+          content.write(remote_content.read)
+        end
+      }.string
+    end
+
+    class << self
+      def call(url)
+        new(url).call
+      end
+    end
+  end
+end

data/lib/script_ripper/parser.rb

@@ -0,0 +1,75 @@
+require "nokogiri"
+require "script_ripper/code_block"
+
+module ScriptRipper
+  class Parser
+    attr_reader :contents
+    attr_reader :group_by
+
+    def initialize(contents, group_by = nil)
+      @contents = contents
+      @group_by = group_by
+    end
+
+    def call
+      code_blocks = document.css("ol").map do |ordered_list|
+        ordered_list.css("li").map do |list_item|
+          CodeBlock.new(
+            description: list_item.css("p").map(&:text).join("\n"),
+            code: list_item.css("code").text,
+            nokogiri_list_item: list_item
+          )
+        end
+      end.flatten.reject { |code_block| code_block.code.nil? || code_block.code.empty? }
+
+      return code_blocks if groupings_hash.empty?
+
+      {}.tap do |result|
+        code_blocks.each do |code_block|
+          grouping = find_previous_grouping_element(find_list_parent(code_block.nokogiri_list_item))
+
+          group_name = grouping&.text
+
+          result[group_name] ||= []
+          result[group_name] << code_block
+        end
+      end
+    end
+
+    class << self
+      def call(contents, group_by = nil)
+        new(contents, group_by).call
+      end
+    end
+
+    private
+
+    def find_previous_grouping_element(element)
+      previous_element = element&.previous_element
+
+      return nil if previous_element.nil?
+      return previous_element if groupings_hash[previous_element.text] == previous_element
+
+      find_previous_grouping_element(previous_element)
+    end
+
+    def find_list_parent(list_item)
+      return list_item if list_item.name == "ol"
+      return nil if list_item.parent.nil?
+
+      find_list_parent(list_item.parent)
+    end
+
+    def document
+      @document ||= Nokogiri::HTML(contents)
+    end
+
+    def groupings
+      @groupings ||= document.css(group_by)
+    end
+
+    def groupings_hash
+      @groupings_hash ||= Hash[groupings.map { |grouping| [grouping.text, grouping] }]
+    end
+  end
+end

data/lib/script_ripper/script_writer.rb

@@ -0,0 +1,40 @@
+module ScriptRipper
+  class ScriptWriter
+    attr_reader :code_blocks, :from_url, :group_name, :io
+
+    def initialize(code_blocks:, from_url:, group_name: nil, io: $stdout)
+      @code_blocks = code_blocks
+      @group_name = group_name
+      @io = io
+      @from_url = from_url
+    end
+
+    def call
+      io.puts "#!/usr/bin/env bash\n\n"
+      io.puts "# #{from_url}\n"
+      io.puts "# #{group_name}\n" if group_name
+      io.puts "\n"
+
+      code_blocks_count = code_blocks.length
+
+      code_blocks.each_with_index do |code_block, i|
+        io.puts(description_to_comment(code_block.description))
+        code_suffix = (i == code_blocks_count - 1) ? "\n" : "\n\n"
+
+        io.puts("#{code_block.code}#{code_suffix}")
+      end
+    end
+
+    class << self
+      def call(code_blocks:, from_url:, group_name: nil, io: $stdout)
+        new(code_blocks: code_blocks, from_url: from_url, group_name: group_name, io: io).call
+      end
+    end
+
+    private
+
+    def description_to_comment(description)
+      description.split("\n").map { |line| "# #{line}" }.join("\n")
+    end
+  end
+end

data/lib/script_ripper/version.rb

@@ -0,0 +1,3 @@
+module ScriptRipper
+  VERSION = "0.1.0"
+end

data/lib/script_ripper.rb

@@ -0,0 +1,2 @@
+module ScriptRipper
+end

data/script_ripper.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "script_ripper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "script_ripper"
+  spec.version       = ScriptRipper::VERSION
+  spec.authors       = ["Dave Benvenuti"]
+  spec.email         = ["davebenvenuti@gmail.com"]
+
+  spec.summary       = %q{Rip shell scripts out of instructional web pages}
+  spec.homepage      = "https://github.com/davebenvenuti/script_ripper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/davebenvenuti/script_ripper"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_runtime_dependency "nokogiri", "~> 1.13"
+
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "debug", "~> 1.6"
+  spec.add_development_dependency "minitest", "~> 5.16"
+  spec.add_development_dependency "mocha", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "vcr", "6.1.0"
+  spec.add_development_dependency "webmock", "~> 3.18"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: script_ripper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Benvenuti
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description:
+email:
+- davebenvenuti@gmail.com
+executables:
+- script_ripper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/script_ripper
+- lib/script_ripper.rb
+- lib/script_ripper/cli.rb
+- lib/script_ripper/code_block.rb
+- lib/script_ripper/downloader.rb
+- lib/script_ripper/parser.rb
+- lib/script_ripper/script_writer.rb
+- lib/script_ripper/version.rb
+- script_ripper.gemspec
+homepage: https://github.com/davebenvenuti/script_ripper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/davebenvenuti/script_ripper
+  source_code_uri: https://github.com/davebenvenuti/script_ripper
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Rip shell scripts out of instructional web pages
+test_files: []