script_ripper 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7b0e4c2b04ee693c936da30f9a0b3cd82cb8dfe9fd566e8209c3b484e1045d
-  data.tar.gz: 3f223964118d46ab91eef43242b64b4c7ceb00e4cb9a946835870fe0b4cfec65
+  metadata.gz: e87995a5227deec059bd902676dc876ab8d28679d7a9a935bf6226fd96f65f24
+  data.tar.gz: cdc950877b56524fd4b5a458016a018f065d33a17705e59c94101334cc5916cb
 SHA512:
-  metadata.gz: 6b7cb40e69daf620555fd6f9670e22a2ae64cc53ddb18a2198fc266d3eb260a6212512affd6d495b08ea283428afdb4f0669be7caa067e64a48ad3782c2b1476
-  data.tar.gz: 272e49d4fbcf127415d4a2e6b4f570ff91417089b66f82da2a586f0185f83c215485a34e55237b4ed1e9cbbceebf0fdacda1bea3559d2f4e58bdac631a3258b4
+  metadata.gz: dc1b7ab672c04339ed68236dd3b5dc076739d95d489366cae71b923a6034813c8b1dc2cc879de4854c5cc66229001a3164fa3f98a13c932cfd9a84104bdd4aa6
+  data.tar.gz: 6cbb76afffc5c87246b241d830ab1d7634d4055e0d6c608e30c9719c7312a183eef07cae37899615a1f1a9ee3ad37c1c60e8daba67d9d4db7bdbfa21a44b90c6

data/.github/workflows/workflow.yml

@@ -0,0 +1,31 @@
+name: CI and CD
+on:
+  - push
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+  cd:
+    env:
+      GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    needs:
+      - ci
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+      - name: Install dependencies
+        run: bundle install
+      - name: Build gem
+        run: bundle exec rake build
+      - name: Publish gem
+        run: gem push pkg/*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    script_ripper (0.1.1)
+    script_ripper (0.2.1)
       nokogiri (~> 1.13)
 
 GEM
@@ -22,6 +22,8 @@ GEM
     mocha (1.14.0)
     nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
     public_suffix (5.0.0)
     racc (1.6.0)
     rake (13.0.6)
@@ -36,6 +38,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.3)

data/README.md

@@ -8,18 +8,67 @@ Given a website like https://jellyfin.org/docs/general/administration/installing
 Get a bash script like
 
 ```bash
+#!/usr/bin/env bash
+
 # https://jellyfin.org/docs/general/administration/installing.html
+# Ubuntu
+
+# Remove the old /etc/apt/sources.list.d/jellyfin.list file:
+/etc/apt/sources.list.d/jellyfin.list
+
+# Remove the old /etc/apt/sources.list.d/jellyfin.list file:
+sudo rm /etc/apt/sources.list.d/jellyfin.list
+
+# Install HTTPS transport for APT if you haven't already:
+sudo apt install apt-transport-https
+
+# Enable the Universe repository to obtain all the FFMpeg dependencies:
+# If the above command fails you will need to install the following package software-properties-common.
+# This can be achieved with the following command sudo apt-get install software-properties-common
+sudo add-apt-repository universe
+
+# If the above command fails you will need to install the following package software-properties-common.
+# This can be achieved with the following command sudo apt-get install software-properties-common
+sudo apt-get install software-properties-common
+
+# Import the GPG signing key (signed by the Jellyfin Team):
+curl -fsSL https://repo.jellyfin.org/ubuntu/jellyfin_team.gpg.key | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/debian-jellyfin.gpg
+
+# Add a repository configuration at /etc/apt/sources.list.d/jellyfin.list:
+/etc/apt/sources.list.d/jellyfin.list
+
+# Add a repository configuration at /etc/apt/sources.list.d/jellyfin.list:
+# Supported releases are bionic, cosmic, disco, eoan, and focal.
+echo "deb [arch=$( dpkg --print-architecture )] https://repo.jellyfin.org/ubuntu $( lsb_release -c -s ) main" | sudo tee /etc/apt/sources.list.d/jellyfin.list
+
+# Update APT repositories:
+sudo apt update
+
+# Install Jellyfin:
+sudo apt install jellyfin
+
+# Manage the Jellyfin system service with your tool of choice:
+sudo service jellyfin status
+sudo systemctl restart jellyfin
+sudo /etc/init.d/jellyfin stop
+
+# Enable the Universe repository to obtain all the FFMpeg dependencies, and update repositories:
+sudo add-apt-repository universe
+sudo apt update
+
+# Install the required dependencies:
+sudo apt install at libsqlite3-0 libfontconfig1 libfreetype6 libssl1.0.0
+
+# Install the downloaded .deb packages:
+sudo dpkg -i jellyfin_*.deb jellyfin-ffmpeg_*.deb
 
-# Download the latest container image.
-docker pull jellyfin/jellyfin
+# Use apt to install any missing dependencies:
+sudo apt -f install
 
-# Create persistent storage for configuration and cache data.
-# Either create two directories on the host and use bind mounts:
-# Or create two persistent volumes:
-mkdir /path/to/config
-mkdir /path/to/cache
-docker volume create jellyfin-config
-docker volume create jellyfin-cache
+# Manage the Jellyfin system service with your tool of choice:
+sudo service jellyfin status
+sudo systemctl restart jellyfin
+sudo /etc/init.d/jellyfin stop
 ```
 
 ## Installation

data/bin/release

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "script_ripper/version"
+
+`bundle`
+
+if `git branch --show-current`.chomp != "master"
+  $stderr.puts "You must be on the master branch to release a new version."
+
+  exit 1
+end
+
+if `git status -s`.length > 0
+  $stderr.puts "Please commit all changes first"
+
+  exit 1
+end
+
+puts `git tag -a v#{ScriptRipper::VERSION} -m "Release v#{ScriptRipper::VERSION}" && git push origin master --tags`

data/lib/script_ripper/cli.rb

@@ -3,9 +3,12 @@ require "optparse"
 require "script_ripper/downloader"
 require "script_ripper/parser"
 require "script_ripper/script_writer"
+require "script_ripper/util"
 
 module ScriptRipper
   class CLI
+    include Util
+
     attr_reader :arguments, :options, :url, :group_name
 
     def initialize(arguments = ARGV)
@@ -17,10 +20,10 @@ module ScriptRipper
       parse_arguments!
 
       content = Downloader.call(url)
-      code_blocks = Parser.call(content, group_by: group_by)
+      code_blocks = Parser.call(content, group_by)
 
       if code_blocks.is_a?(Hash)
-        ScriptWriter.call(code_blocks: code_blocks[group_name], from_url: url, group_name: group_name)
+        ScriptWriter.call(code_blocks: code_blocks.fetch(group_name), from_url: url, group_name: group_name)
       else
         ScriptWriter.call(code_blocks: code_blocks, from_url: url)
       end
@@ -47,7 +50,7 @@ module ScriptRipper
         opts.on(
           "-g GROUPBY",
           "--group-by GROUPBY",
-          "Group by an element type (typically something like h2, h3, etc.  Required if group_name is provided."
+          "Group by an element type, typically something like h2, h3, etc.  Required if group_name is provided."
         )
 
         opts.on("-h", "--help", "Show this message")
@@ -79,16 +82,5 @@ module ScriptRipper
       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/parser.rb

@@ -1,8 +1,13 @@
 require "nokogiri"
+require "set"
+
 require "script_ripper/code_block"
+require "script_ripper/util"
 
 module ScriptRipper
   class Parser
+    include Util
+
     attr_reader :contents
     attr_reader :group_by
 
@@ -14,21 +19,36 @@ module ScriptRipper
     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
-          )
+          list_item.css("code").map do |code_element|
+            parent_p_element = find_p_parent(code_element)
+            if parent_p_element
+              # This means the code block is inside a <p/> element
+              CodeBlock.new(
+                description: parent_p_element.text,
+                code: code_element.text,
+                nokogiri_list_item: list_item
+              )
+            else
+              # This means the code block is preceded by zero or more <p/> elements
+              CodeBlock.new(
+                description: list_item.css("p").map(&:text).join("\n"),
+                code: code_element.text,
+                nokogiri_list_item: list_item
+              )
+            end
+          end
         end
-      end.flatten.reject { |code_block| code_block.code.nil? || code_block.code.empty? }
+      end.flatten.reject { |code_block| blank?(code_block.code) }
 
-      return code_blocks if groupings_hash.empty?
+      return code_blocks if blank?(group_by)
 
       {}.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
+          next if grouping.nil?
+
+          group_name = grouping.text
 
           result[group_name] ||= []
           result[group_name] << code_block
@@ -48,7 +68,7 @@ module ScriptRipper
       previous_element = element&.previous_element
 
       return nil if previous_element.nil?
-      return previous_element if groupings_hash[previous_element.text] == previous_element
+      return previous_element if grouping_names.include?(previous_element.text)
 
       find_previous_grouping_element(previous_element)
     end
@@ -68,8 +88,16 @@ module ScriptRipper
       @groupings ||= document.css(group_by)
     end
 
-    def groupings_hash
-      @groupings_hash ||= Hash[groupings.map { |grouping| [grouping.text, grouping] }]
+    def grouping_names
+      @grouping_names ||= Set.new(groupings.map(&:text))
+    end
+
+    def find_p_parent(element)
+      return nil if element == document.root
+      return nil if blank?(element)
+      return element if element.name == "p"
+
+      find_p_parent(element.parent)
     end
   end
 end

data/lib/script_ripper/script_writer.rb

@@ -23,6 +23,12 @@ module ScriptRipper
 
         io.puts("#{code_block.code}#{code_suffix}")
       end
+
+      # if $record
+      #   File.open("test/fixtures/jellyfin-ubuntu.sh", "w") do |file|
+      #     file.write(io.string)
+      #   end
+      # end
     end
 
     class << self

data/lib/script_ripper/util.rb

@@ -0,0 +1,15 @@
+module ScriptRipper
+  module Util
+    def present?(value)
+      return false if value.nil?
+      return false if value.respond_to?(:empty?) && value.empty?
+      return false if value.respond_to?(:length) && value.length == 0
+
+      true
+    end
+
+    def blank?(value)
+      !present?(value)
+    end
+  end
+end

data/lib/script_ripper/version.rb

@@ -1,3 +1,3 @@
 module ScriptRipper
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: script_ripper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Dave Benvenuti
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
 date: 2022-09-04 00:00:00.000000000 Z
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.18'
-description:
+description: 
 email:
 - davebenvenuti@gmail.com
 executables:
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/workflow.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
@@ -140,6 +141,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/release
 - bin/setup
 - exe/script_ripper
 - lib/script_ripper.rb
@@ -148,6 +150,7 @@ files:
 - lib/script_ripper/downloader.rb
 - lib/script_ripper/parser.rb
 - lib/script_ripper/script_writer.rb
+- lib/script_ripper/util.rb
 - lib/script_ripper/version.rb
 - script_ripper.gemspec
 homepage: https://github.com/davebenvenuti/script_ripper
@@ -156,7 +159,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/davebenvenuti/script_ripper
   source_code_uri: https://github.com/davebenvenuti/script_ripper
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -172,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Rip shell scripts out of instructional web pages
 test_files: []