rackstaticapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b75d295d744a5d99244465bf09f844411d6454aee410078f250b1189fb07859e
+  data.tar.gz: 43a72ce12e72f8de8d009dafce6d28dfa34924ede1ef95cf01282c4d653d7b18
+SHA512:
+  metadata.gz: 723187e70cddd2b1ecf20e60fed9662a09d9c67f765500aa1e9bb50db7b1c3db9bfa9eae277943fef39130b22c27f65a673a38dd070c14768fdc7bb4dd73c037
+  data.tar.gz: b1b5e00ea182da1211d6934fffe5683f627c833983a18f955248ee5c7d771270fc19973e9095047c257eca3332241d86e68e27f81acf51508a4c3aa2a499e366

data/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+on:
+  push:
+    branches:
+      - "master" # main only
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/release-please-action@v2
+        id: release
+        with:
+          release-type: ruby
+          package-name: rackstaticapp
+          bump-minor-pre-major: true
+          bump-patch-for-minor-pre-major: true
+          version-file: "lib/rackstaticapp/version.rb"
+
+      # Checkout code if release was created
+      - uses: actions/checkout@v2
+        if: ${{ steps.release.outputs.release_created }}
+
+      # Setup ruby if a release was created
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+        if: ${{ steps.release.outputs.release_created }}
+      - name: Run tests
+        run: |
+          bundle exec rake test
+        if: ${{ steps.release.outputs.release_created }}
+
+      # Publish
+      - name: publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          bundle exec rake build
+          gem push pkg/*.gem
+        env:
+          # Make sure to update the secret name
+          # if yours isn't named RUBYGEMS_AUTH_TOKEN
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        if: ${{ steps.release.outputs.release_created }}
+
+      - name: Upload Release Artifact
+        if: ${{ steps.release.outputs.release_created }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run:
+          gh release upload ${{ steps.release.outputs.tag_name }} pkg/*.gem

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Run tests
+on:
+  push:
+    branches:
+      - "**" # matches every branch
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Run tests
+        run: |
+          bundle exec rake test

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (2023-09-10)
+
+
+### Bug Fixes
+
+* Integrated PR [#6](https://www.github.com/iphoting/RackStaticApp/issues/6) from upstream Vienna repo. ([5e560b0](https://www.github.com/iphoting/RackStaticApp/commit/5e560b02fddf9c5e3b57b98c1cbd2c2c1db8cfa3))

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'yard'
+
+task :default => :test
+
+desc 'Run tests'
+task :test do
+  Dir.chdir 'spec'
+  system 'ruby -I ../lib spec.rb'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['--markup=markdown']
+end

data/lib/rackstaticapp/version.rb

@@ -0,0 +1,3 @@
+module RackStaticApp
+  VERSION = '0.1.0'
+end

data/lib/rackstaticapp.rb

@@ -0,0 +1,98 @@
+require 'rackstaticapp/version'
+require 'rack'
+require 'vienna'
+
+##
+# Zero-configuration convenience wrapper around `RackStaticApp::Application`, which inherits from `Vienna::Application`.
+# Add this to your `config.ru`:
+#
+#     require 'rackstaticapp'
+#     run RackStaticApp
+#
+# Your static site in `public` will be served.
+#
+
+module RackStaticApp
+
+  class << self
+    def call(env)
+      Application.new.call(env)
+    end
+  end
+
+  ##
+  # `RackStaticApp::Static` is just a wrapper for `Rack::Static` with
+  # sane and opinionated options.
+  #
+  # It serves all files under the given `root` and doesn't passes on requests
+  # for files that don't exist.
+  #
+  # Examples
+  #
+  #     use RackStaticApp::Static, 'public'
+  #
+
+  class Static < Vienna::Static
+    def initialize(app, root)
+      super
+    end
+
+    def urls
+      [""]
+    end
+
+    def root
+      super
+    end
+
+    def index
+      super
+    end
+
+    def header_rules
+      super
+    end
+
+    def options
+      {urls: urls, root: root, index: index, header_rules: header_rules, cascade: true}
+    end
+  end
+
+  ##
+  # `RackStaticApp::NotFound` is a default endpoint not unlike `Rack::NotFound`.
+  # Initialize it with the path to a 404 page and its contents will be served.
+  # The difference is that if a 404 page doesn't exist, a default response,
+  # 'Not Found' will be served.
+  #
+  # Examples
+  #
+  #     run RackStaticApp::NotFound.new('public/404.html')
+  #
+  #     run RackStaticApp::NotFound.new # Always return 'Not Found'
+  #
+
+  class NotFound < Vienna::NotFound
+  end
+
+  ##
+  # `RackStaticApp::Application` serves all files under the given root directory
+  # using `RackStaticApp::Static`. If a file/path doen't exist, `RackStaticApp::NotFound`
+  # is run, which always returns a status of `404` and the contents of
+  # `404.html` or `'Not Found'` if one does not exist.
+  #
+  # Examples
+  #
+  #     run RackStaticApp::Application.new('_site')
+  #
+  #     run RackStaticApp::Application.new # The root defaults to 'public'
+  #
+
+  class Application < Vienna::Application
+    def initialize(root = 'public')
+      @app = Rack::Builder.new do
+        use Static, root
+        run NotFound.new("#{root}/404.html")
+      end
+    end
+  end
+end

data/rackstaticapp.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'rackstaticapp/version'
+
+Gem::Specification.new do |s|
+  s.name        = "rackstaticapp"
+  s.version     = RackStaticApp::VERSION
+  s.summary     = "An update to the Vienna, a tiny zero-config rack app to serve static files"
+  s.description = "A tiny zero-config Rack App to serve static files"
+  s.authors     = ["Ronald Ip", "Mikael Konutgan"]
+  s.email       = "myself@iphoting.com"
+  s.homepage    =
+    "https://rubygems.org/gems/rackstaticapp"
+  s.license       = "MIT"
+
+  s.files       = `git ls-files`.split("\n")
+  s.executables   = s.files.grep(/^bin\//) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(/^(test|spec|features)\//)
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rack', '~> 2.0'
+  s.add_runtime_dependency 'vienna', '~> 0.4.0'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'yard', '~> 0.9'
+end

data/spec/public/404.html

@@ -0,0 +1 @@
+404

data/spec/public/about.html

@@ -0,0 +1 @@
+about

data/spec/public/css/style.css

@@ -0,0 +1 @@
+style

data/spec/public/images/image.svg

@@ -0,0 +1 @@
+image

data/spec/public/index.html

@@ -0,0 +1 @@
+index

data/spec/spec.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'rack/mock'
+require 'rackstaticapp'
+
+describe RackStaticApp do
+  before do
+    app = Rack::Builder.new do
+      use Rack::Lint
+      run RackStaticApp
+    end
+    
+    @request = Rack::MockRequest.new(app)
+  end
+  
+  describe 'when requesting the root directory' do
+    before do
+      @res = @request.get('/')
+    end
+    
+    it 'should serve the index path' do
+      _(@res.body.chomp).must_equal 'index'
+    end
+    
+    it 'should return a valid status code, that is 200: OK or 304: Not Modified' do
+      _([200, 304]).must_include @res.status
+    end
+  end
+  
+  describe 'when requesting the path of a subdirectory of the root directory' do
+    before do
+      @paths = {
+        '/css/style.css'    => 'style',
+        '/images/image.svg' => 'image',
+        '/about.html'       => 'about'
+      }
+    end
+    
+    it 'should serve the contents of the paths' do
+      @paths.each do |path, body|
+        _(@request.get(path).body.chomp).must_equal body
+      end
+    end
+    
+    it 'should cache all responses for a an hour' do
+      @paths.each do |path, body|
+        _(@request.get(path).headers['Cache-Control']).must_equal 'public, max-age=3600'
+      end
+    end
+  end
+  
+  describe 'when requesting a path that does not exist' do
+    before do
+      @res = @request.get('/path')
+    end
+    
+    it 'should serve the contents of `404.html` if the file exists' do
+      _(@res.body.chomp).must_equal '404'
+    end
+    
+    it 'should return the status code 404: Not Found' do
+      _(@res.status).must_equal 404
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rackstaticapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronald Ip
+- Mikael Konutgan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: vienna
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A tiny zero-config Rack App to serve static files
+email: myself@iphoting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Rakefile
+- lib/rackstaticapp.rb
+- lib/rackstaticapp/version.rb
+- rackstaticapp.gemspec
+- spec/public/404.html
+- spec/public/about.html
+- spec/public/css/style.css
+- spec/public/images/image.svg
+- spec/public/index.html
+- spec/spec.rb
+homepage: https://rubygems.org/gems/rackstaticapp
+licenses:
+- MIT
+metadata: {}
+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.4.10
+signing_key:
+specification_version: 4
+summary: An update to the Vienna, a tiny zero-config rack app to serve static files
+test_files:
+- spec/public/404.html
+- spec/public/about.html
+- spec/public/css/style.css
+- spec/public/images/image.svg
+- spec/public/index.html
+- spec/spec.rb