capistrano-simple-htaccess 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35139b12b49d409ca16b35e3fbd18586dba5659bb1b7016149e7be005b787475
-  data.tar.gz: d0944982eb9e035609e829d6ba65489ddb5687a78b8145e9df28e01cc7993e6d
+  metadata.gz: 6ddc60528f1bed0b05195d15e22c42455be872af1a0a938cb94e340588672bf3
+  data.tar.gz: d8a6a396a4e4ea89fede3af95fb9999d5124728d320263fd72750384a945f22f
 SHA512:
-  metadata.gz: a000b6575f48434523d09c19566fe4b0a6fd03172aebe57abcbac906cdcbf58856c205b7067fd488b56e4b9fc3d485210bbfe9ac3d891c958a74a766f66d163b
-  data.tar.gz: 7179b543039b2f6060b57b4a3ddd77f37734fa3d8f88e688b796fca500226744abeb92dd559ed33760feeb20573b069e57c7b112b54a6381c3cd8399387a6048
+  metadata.gz: 37b051405bbf85f447e89971bcb86ddd1f353f30e186c9facbcfb3f06127b97599188074f50bbdb35a35a2989207ed30bffd54ac8bc0fda34fe311441b689bd1
+  data.tar.gz: 14247d574c48e9410dc0e183375e1668c7232bfb38d6dfcf71472edf4ae4824dd8013460fc3763c17af0a3719e82f85e3c3653c64b882202e3266499d8c75d0a

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayStyleGuide: true
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ### master
 
+### v1.0.0, 2020-11-10
+
+- Refactor default `.htaccess` file to externally redirect out of capistrano's 'current' directory
+  - This requires setting a new `:document_root` variable so the new  `.htaccess` file can function
+  - `:document_root` should be set to what your Apache's `DocumentRoot` is set to. The rake task will use this to dynamically build the `.htaccess`
+
 ### v0.1.1, 2020-03-17
 
 - Run Rubocop formatters on source

data/Gemfile

@@ -1,3 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in test-gem.gemspec
 gemspec
+
+gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    capistrano-simple-htaccess (1.0.0)
+      capistrano (~> 3.14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.4.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    ast (2.4.1)
+    capistrano (3.14.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.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)
+    sshkit (1.21.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  capistrano-simple-htaccess!
+  rake (~> 13.0)
+  rubocop (>= 1.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 DaMoo
+Copyright (c) 2020 DaMoo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -38,17 +38,29 @@ Found as a HEREDOC string in `lib/capistrano/tasks/simple_htaccess.rake`, but al
   Options +FollowSymLinks
 
   RewriteEngine On
-  RewriteCond %{REQUEST_URI} !/current/
-  RewriteRule ^(.*)$ current/$1 [L]
+  RewriteBase "%<base>s"
+  RewriteRule ^current(.*) %<base>s$1 [NC,R,END]
+  RewriteRule ^((?!current/).*)$ current/$1 [NC,END]
 </IfModule>
 ```
 
+The `%<base>s` template strings are replaced with the value of your `:deploy_to` directory, with the `:document_root` variable removed from the string's prefix. This creates a base directory string.
+
+Ex: 
+
+```ruby
+set :deploy_to, '/var/www/html/example1/public'
+set :document_root, '/var/www/html'
+
+# %<base>s would then be replaced with: /example1/public
+```
+
 ## Configuration
 
 If you want a different .htaccess uploaded, just change the `:HTACCESS` variable as part of your deploy config. Ex:
 
 ```ruby
-set(:HTACCESS), <<HTACCESS
+set :HTACCESS, <<HTACCESS
 # Put your .htaccess config here
 HTACCESS
 ```

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'capistrano/simple_htaccess'
+
+# 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/capistrano-simple-htaccess.gemspec

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'capistrano/simple_htaccess/version'
+require_relative 'lib/capistrano/simple_htaccess/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-simple-htaccess'
@@ -13,15 +11,24 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Capistrano task for including a simple apache .htaccess file for redirects on deploy'
   spec.homepage      = 'https://github.com/da-moo/capistrano-simple-htaccess'
   spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
 
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/da-moo/capistrano-simple-htaccess'
+  spec.metadata['changelog_uri'] = 'https://github.com/da-moo/capistrano-simple-htaccess/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) 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 'capistrano', '~> 3.12'
+  spec.add_dependency 'capistrano', '~> 3.14'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rubocop', '>= 1.2'
 end

data/lib/capistrano/simple_htaccess/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module SimpleHtaccess
-    VERSION = '0.1.1'
+    VERSION = '1.0.0'
   end
 end

data/lib/capistrano/tasks/simple_htaccess.rake

@@ -3,13 +3,15 @@
 namespace :load do
   task :defaults do
     set :redirect_OK, false
+    set :document_root, '/var/www/html'
     set :HTACCESS, <<~HTACCESS
       <IfModule mod_rewrite.c>
         Options +FollowSymLinks
 
         RewriteEngine On
-        RewriteCond %{REQUEST_URI} !/current/
-        RewriteRule ^(.*)$ current/$1 [L]
+        RewriteBase "%<base>s"
+        RewriteRule ^current(.*) %<base>s$1 [NC,R,END]
+        RewriteRule ^((?!current/).*)$ current/$1 [NC,END]
       </IfModule>
 
     HTACCESS
@@ -20,9 +22,10 @@ namespace :deploy do
   namespace :simple_htaccess do
     task :create_htaccess do
       on roles :web do
-        unless fetch(:redirect_OK)
-          upload! StringIO.new(fetch(:HTACCESS)), "#{deploy_to}/.htaccess"
-        end
+        document_root = fetch :document_root
+        base_dir = deploy_to.delete_prefix(document_root)
+        filled_template = format(fetch(:HTACCESS), base: base_dir)
+        upload! StringIO.new(filled_template), "#{deploy_to}/.htaccess" unless fetch(:redirect_OK)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-simple-htaccess
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - DaMoo
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
-description: 
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description:
 email:
 - git@damoo.zone
 executables: []
@@ -60,11 +74,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - capistrano-simple-htaccess.gemspec
 - lib/capistrano/simple_htaccess.rb
 - lib/capistrano/simple_htaccess/version.rb
@@ -72,8 +90,11 @@ files:
 homepage: https://github.com/da-moo/capistrano-simple-htaccess
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/da-moo/capistrano-simple-htaccess
+  source_code_uri: https://github.com/da-moo/capistrano-simple-htaccess
+  changelog_uri: https://github.com/da-moo/capistrano-simple-htaccess/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,15 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Capistrano task for including a simple apache .htaccess file for redirects
   on deploy