rails-etcs 0.0.0 → 0.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c931873937bb5e6d230bd181eba6382c34b2e430
-  data.tar.gz: b8f016cfb9b88f5ff1d5a0b194295e660ebbbba4
+SHA256:
+  metadata.gz: 4f5e1ab5d87f3089d00586c7c88630f8203e07f8149c88c6d1f3f70d42c13b6f
+  data.tar.gz: 0c1b6db67d1b14ff02b8167c7cb8f993b67e64d3064f8e00a35328a875062996
 SHA512:
-  metadata.gz: 5921cdd680e47dfde236cc28629d9c94dafcb0d339fd3a44b95e68981667be2587f8674cece318f9422aff1f1931d45d659adadd390dec83b155ffa7039407dc
-  data.tar.gz: cc59f4b4d58b4d9f0f82620286a20c8733b771f187264d0bb4263ba2b4c4264e675a0e65f2ab9acdb49f90d62a5b4a6b51dba58c1306ba456ffccdad8df1c08c
+  metadata.gz: a8e5a731e0e82c10ce5a77a42b570e3329fcdb0812307edaacbd98f5295867b1089e94bef37b6cdc394e188250422520227cf9914e98e74b62c126802b72e362
+  data.tar.gz: c0eec6f6a6da21a082830ec15a5eb36206cb4da9f5fc352f6d8e6e400a9af313b4c2729f93a18215261984ec2f85aa3c5901454a3373b483f4fa6d02a53914b9

data/.gitignore

@@ -1,9 +1,15 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+# rspec failure tracking
+/spec/examples.txt
+
+# Bundler lockfiles
+/Gemfile.lock
+/gemfiles/*.lock

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,59 @@
+AllCops:
+  Include:
+    - '**/*.rb'
+  TargetRubyVersion: 2.3
+
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+
+
+Naming/FileName:
+  Exclude:
+    - Appraisals
+    - Gemfile
+    - Rakefile
+    - rails-etcs.gemspec
+
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.travis.yml

@@ -1,6 +1,16 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.5.0
+  - 2.4.3
+  - 2.3.6
+gemfiles:
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_head.gemfile
 before_install:
-  - gem install bundler -v 1.13.3
+  - gem install bundler -v 1.16.1
+script:
+  - bundle exec rspec

data/Appraisals

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+appraise 'rails-4.2' do
+  gem 'rails', '~> 4.2.0'
+end
+
+appraise 'rails-5.0' do
+  gem 'rails', '~> 5.0.0'
+end
+
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1.0'
+end
+
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0.rc'
+end
+
+appraise 'rails-head' do
+  gem 'rails', github: 'rails/rails'
+end

data/Gemfile

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
 # Specify your gem's dependencies in rails-etcs.gemspec
 gemspec
 
+gem 'appraisal'
 gem 'rake'
 gem 'rspec', '~> 3.0'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jan Graichen
+
+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

@@ -1,4 +1,4 @@
-# Rails::ETCS
+# Rails::Etcs
 
 A collection of patches and alternatives for Rails core classes.
 
@@ -8,5 +8,46 @@ If you cannot install the gem alone you should better not use it.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Rails::Etcs::Application
 
+`Rails::Etcs::Application` can be used instead of `Rails::Application` when creating your own applications:
+
+```ruby
+# my-app/config/application.rb
+
+module MyApp
+  class Application < ::Rails::Etcs::Application
+    self.ident = 'my-app'
+  end
+end
+```
+
+`Rails::Etcs::Application` is tuned in several ways:
+
+#### Application Paths
+
+Most paths have been adjusted to allow moving static files such as `config/application.rb`, `config/routes.rb`, `config/environment.rb`, `config/initializers`, `config/environments`, `config/locales` to `app/`. You can therefore move all application code into the application directory. `config/boot.rb` could be moved manually.
+
+This way it is possible to have an application where `config/` really only contains (end-user) configuration files.
+
+#### XDG Base Directory Specification
+
+The application will further respect the XDG Base Directory Specification for looking up configuration files and temp directories.
+
+You can customize the application name via `self.ident = 'my-app'`. Configuration file by search e.g. in:
+
+* `~/.config/my-app`
+* `/etc/xdg/my-app`
+* `/etc/my-app`
+* `config`
+
+`#config_for` has been patched to search for the first existing configuration file in any existing configuration directory.
+
+The same lookup is applied for `database.yml`, `secrets.yml`, and additional
+initializers and environments files.
+
+## License
+
+Rails::Etcs (c) 2018 Jan Graichen
+
+It is free software, and may be redistributed under the terms of The MIT License (MIT).

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 "rails/etcs"
+require 'bundler/setup'
+require 'rails/etcs'
 
 # 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 "rails/etcs"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require 'irb'
+IRB.start(__FILE__)

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 5.2.0.rc"
+
+gemspec path: "../"

data/gemfiles/rails_head.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "rails", git: "https://github.com/rails/rails"
+
+gemspec path: "../"

data/lib/rails/etcs/application/configuration.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'xdg'
+
+class Rails::Etcs::Application
+  class Configuration < ::Rails::Application::Configuration
+    attr_reader :ident
+
+    def initialize(root, ident)
+      super root
+
+      @ident = ident
+    end
+
+    # rubocop:disable AbcSize
+    # rubocop:disable MethodLength
+    def paths
+      @paths ||= begin
+        paths = super
+
+        paths.add 'lib',    eager_load: true
+        paths.add 'tmp',    with: xdg_cache.flatten
+        paths.add 'config', with: xdg_config.flatten
+
+        paths.add 'config/environment',
+          with: %w[app/environment.rb config/environment.rb]
+
+        paths.add 'config/initializers',
+          with: %w[app/initializers],
+          glob: '**/*.rb'
+
+        paths.add 'config/locales',
+          with: %w[app/locales config/locales],
+          glob: '*.{rb,yml}'
+
+        paths.add 'config/routes.rb',
+          with: %w[app/routes.rb config/routes.rb]
+
+        paths.add 'config/environments',
+          with: %w[app/environments],
+          glob: "#{Rails.env}.rb"
+
+        paths.add 'config/database',
+          with: paths['config'].each.map {|d| File.join(d, 'database.yml') }
+
+        paths.add 'config/secrets',
+          with: paths['config'],
+          glob: 'secrets.yml{,.enc}'
+
+        paths['config'].to_ary.reverse.each do |dir|
+          paths['config/initializers'] << File.join(dir, 'initializers')
+          paths['config/environments'] << File.join(dir, 'environments')
+        end
+
+        paths
+      end
+    end
+    # rubocop:enable all
+
+    private
+
+    def xdg_config
+      [XDG['CONFIG'].with_subdirectory(ident), 'config'].flatten
+    end
+
+    def xdg_cache
+      [XDG['CACHE'].with_subdirectory(ident).to_ary.reverse, 'tmp'].flatten
+    end
+  end
+end

data/lib/rails/etcs/application.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rails::Etcs
+  class Application < ::Rails::Application
+    require 'rails/etcs/application/configuration'
+
+    def config
+      @config ||= begin
+        root = self.class.find_root self.class.called_from
+
+        Application::Configuration.new root, self.class.ident
+      end
+    end
+
+    # rubocop:disable AbcSize
+    # rubocop:disable MethodLength
+    def config_for(name, env: Rails.env)
+      files = paths['config']
+              .expanded
+              .map {|d| Pathname.new(d).join("#{name}.yml") }
+
+      yaml = files.find(&:exist?)
+
+      unless yaml
+        raise "Could not load configuration. No such file - #{files.join(', ')}"
+      end
+
+      require 'erb'
+
+      data = YAML.safe_load(ERB.new(yaml.read).result) || {}
+      data.fetch(env, {})
+    rescue Psych::SyntaxError => e
+      raise <<~ERR
+        YAML syntax error occurred while parsing #{yaml}.
+        Please note that YAML must be consistently indented using spaces.
+        Tabs are not allowed.
+        Error: #{e.message}
+      ERR
+    end
+    # rubocop:enable all
+
+    class << self
+      attr_writer :ident
+
+      def ident
+        @ident ||= begin
+          name.underscore.gsub(/[^A-z]+/, '-').gsub(/-application$/, '')
+        end
+      end
+    end
+  end
+end

data/lib/rails/etcs/version.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Rails
-  module ETCS
+  module Etcs
     module VERSION
       MAJOR = 0
-      MINOR = 0
+      MINOR = 1
       PATCH = 0
-      STAGE = nil
+      STAGE = :beta1
 
       STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
 

data/lib/rails/etcs.rb

@@ -1,7 +1,10 @@
-require "rails/etcs/version"
+# frozen_string_literal: true
+
+require 'rails'
+require 'rails/etcs/version'
 
 module Rails
-  module ETCS
-    # Your code goes here...
+  module Etcs
+    require 'rails/etcs/application'
   end
 end

data/rails-etcs.gemspec

@@ -1,25 +1,30 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rails/etcs/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rails-etcs'
-  spec.version       = Rails::ETCS::VERSION
+  spec.version       = Rails::Etcs::VERSION
   spec.authors       = ['Jan Graichen']
   spec.email         = ['jgraichen@altimos.de']
 
-  spec.summary       = %q{Collection of patches and alternatives for Rails core classes}
-  spec.description   = %q{Collection of patches and alternatives for Rails core classes}
+  spec.summary       = 'Collection of patches and alternatives for Rails core classes'
+  spec.description   = 'Collection of patches and alternatives for Rails core classes'
   spec.homepage      = 'https://github.com/jgraichen/rails-etcs'
-  spec.license       = 'LGPLv3'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-                         f.match(%r{^(test|spec|features)/})
-                       end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(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 'xdg', '~> 2.2.3'
+  spec.add_dependency 'railties', '>= 4.2.0'
+
   spec.add_development_dependency 'bundler', '~> 1.13'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails-etcs
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0.beta1
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -33,18 +61,29 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/.bundle/config
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_head.gemfile
 - lib/rails/etcs.rb
+- lib/rails/etcs/application.rb
+- lib/rails/etcs/application/configuration.rb
 - lib/rails/etcs/version.rb
 - rails-etcs.gemspec
 homepage: https://github.com/jgraichen/rails-etcs
 licenses:
-- LGPLv3
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -57,12 +96,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Collection of patches and alternatives for Rails core classes