rack-capture 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca614d90af90f94f06ccb59fc0a2a5ad476e70170bbc06bda2dbce601f9037c1
-  data.tar.gz: 79ed210bc2976e4e38952dd237e174c4a4057a03105903ad8fc245c09a70dd80
+  metadata.gz: 2f79f70c288700c5f342644d33ea160284c03f736bcf7087ed283040b9c2e7ba
+  data.tar.gz: 491769ee97aa6a55ded4ddb4db0b6c57625806bf4f4f7af9b3773e6e8e738894
 SHA512:
-  metadata.gz: 6cd08848f826f9f44c5144edcf21571166a7cf579565eabf1963309925690f7bf95d15b5192d8baf5957297103ec652c450bf3d4ebea0ab46c7ad78b7ed223bb
-  data.tar.gz: 90de2cc42390fa8783b8dcdabd19f00a561446c6518c012b6cfe9a35cfbdd5a8d2575cdf5afd32ee04623bee758a59814fd6f1980d5243b8a69e438fb9844422
+  metadata.gz: 77ed9519baed02126f4bf1075c482ae3915e24042844eb6b7c4157aa809cef3021887c0fa5873c29f1b5b2728cd6a450aa4a0a460ec45ef840b52177eb28a2c8
+  data.tar.gz: 506a67af2aeeebb56e2a8e0abb079b4a8dae933988eb422cc6b3af6347ca3c43aa98d4d86290222a2785bbe148db660844b9581f6932b691ea91e3f786489fd5

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7.2'
+      - run: bundle install --jobs=$(($(nproc) - 1)) --retry=3
+      - run: bundle exec rubocop --color --parallel
+      - run: bundle exec rspec --force-color

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: '2.5'
+
+Metrics:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.4.0 - 2020-11-06
+
+### Added
+
+- Add `:output_directory_path` option.
+
+### Changed
+
+- Change default output path from `"dist"` to `"output"`.
+
+### Fixed
+
+- Fix output file name on GET /script_name/.
+
+## 0.3.0 - 2020-11-06
+
+### Added
+
+- Add `:script_name` option.
+
+### Changed
+
+- Change least require ruby version from 2.4.0 to 2.5.0.
+
+### Fixed
+
+- Fix frozen bug when a frozen body is passsed.
+
+## 0.2.0 - 2020-11-06
+
+### Changed
+
+- Change least require ruby version from 2.3.0 to 2.4.0.
+
+## 0.1.2 - 2020-10-28
+
+### Fixed
+
+- Fix wrong module name.
+
+## 0.1.1 - 2020-10-28
+
+### Added
+
+- Add Rack::Capture.call.
+
+## 0.1.0 - 2020-10-28
+
+### Added
+
+- Add Rack::Capture.

data/Gemfile

@@ -1,7 +1,11 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-capture.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'fakefs'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'

data/Gemfile.lock

@@ -1,15 +1,23 @@
 PATH
   remote: .
   specs:
-    rack-capture (0.1.0)
+    rack-capture (0.4.0)
       rack
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     diff-lcs (1.4.4)
+    fakefs (1.2.2)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     rack (2.2.3)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -23,14 +31,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  fakefs
   rack-capture!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,5 +1,8 @@
 # Rack::Capture
 
+[![](https://badge.fury.io/rb/rack-capture.svg)](https://rubygems.org/gems/rack-capture)
+[![test](https://github.com/r7kamura/rack-capture/workflows/test/badge.svg)](https://github.com/r7kamura/rack-capture/actions?query=workflow%3Atest)
+
 Generate static files from Rack application and URLs.
 
 ## Installation
@@ -23,6 +26,8 @@ Or install it yourself as:
 Call `Rack::Capture.call` to generate static file.
 
 ```ruby
+require 'rack/capture'
+
 %w[
   http://example.com/
   http://example.com/articles
@@ -36,8 +41,16 @@ Call `Rack::Capture.call` to generate static file.
     app: my_rack_application,
     url: url
   )
+end
 ```
 
+### Arguments
+
+- `:app` - Rack application to be used for rendering response
+- `:url` - URL
+- `:output_directory_path` - Where to output files (default: `"output"`)
+- `:script_name` - Rack SCRIPT_NAME, commonly used for GitHub Pages project sites (default: `""`)
+
 ## Development
 
 ### Setup

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rack/capture"
+require 'bundler/setup'
+require 'rack/capture'
 
 # 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.
@@ -10,5 +11,5 @@ require "rack/capture"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rack/capture.rb

@@ -1,27 +1,30 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'rack'
 require 'rack/capture/version'
 
-module R7k
+module Rack
   class Capture
     class << self
-      # @param [#call] app Rack application.
-      # @param [String] url
-      def call(
-        app:,
-        url:
-      )
-        new(app: app, url: url).call
+      def call(**args)
+        new(**args).call
       end
     end
 
     # @param [#call] app Rack application.
+    # @param [String] output_directory_path
+    # @param [String] script_name
     # @param [String] url
     def initialize(
       app:,
-      url:
+      url:,
+      output_directory_path: 'output',
+      script_name: ''
     )
       @app = app
+      @output_directory_path = output_directory_path
+      @script_name = script_name
       @url = url
     end
 
@@ -31,7 +34,7 @@ module R7k
       destination.parent.mkpath
       content = ''
       response.body.each do |element|
-        content << element
+        content += element
       end
       destination.write(content)
     end
@@ -40,11 +43,9 @@ module R7k
 
     # @param [Rack::Response] response
     def calculate_destination(response:)
-      destination = ::Pathname.new("dist#{uri.path}")
+      destination = ::Pathname.new("#{@output_directory_path}#{path_info}")
       if response.content_type&.include?('text/html')
-        if uri.path == '/'
-          destination += 'index'
-        end
+        destination += 'index' if path_info == '/'
         destination = destination.sub_ext('.html')
       end
       destination
@@ -56,16 +57,21 @@ module R7k
       ::Rack::Response.new(body, status, headers)
     end
 
+    # @return [String]
+    def path_info
+      uri.path.delete_prefix(@script_name)
+    end
+
     # @return [Hash]
     def rack_env
       {
         'HTTP_HOST' => @host,
-        'PATH_INFO' => uri.path,
+        'PATH_INFO' => path_info,
         'QUERY_STRING' => uri.query || '',
         'rack.url_scheme' => rack_url_scheme,
         'REQUEST_METHOD' => 'GET',
-        'SCRIPT_NAME' => '',
-        'SERVER_NAME' => uri.host,
+        'SCRIPT_NAME' => @script_name,
+        'SERVER_NAME' => uri.host
       }
     end
 

data/lib/rack/capture/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Rack
   class Capture
-    VERSION = "0.1.0"
+    VERSION = '0.4.0'
   end
 end

data/rack-capture.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/rack/capture/version'
 
 Gem::Specification.new do |spec|
@@ -9,12 +11,13 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Generate static files from Rack application and URLs.'
   spec.homepage      = 'https://github.com/r7kamura/rack-capture'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-capture
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -31,9 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -50,6 +52,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/r7kamura/rack-capture
   source_code_uri: https://github.com/r7kamura/rack-capture
+  changelog_uri: https://github.com/r7kamura/rack-capture/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -58,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4