dry-web 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebcf4adb58017f9e639efb394e9beffed9569647
-  data.tar.gz: 04635ad8ebd204c99a9b07cd058c5153d72ac688
+  metadata.gz: 97793e4957eae5c7a9ef6d23940ea36b3a6c0b39
+  data.tar.gz: f44ea39a81319979561bbf1b36dcc954bd61aa77
 SHA512:
-  metadata.gz: b66229021044639a2abe4d42d4f4728deed718cd774324f1b551a8ebd6ef1c533f5bd4a7720753ada38c135ade1a47aaf9fcb4814cd8a6a621d2fa8d764b31bb
-  data.tar.gz: 2095506487f2aafa110dc75eba1dd202fd8a6ab9fadefafc5885e628dba7fb4aab8d80a3339d3080f22530d18b958d773005a5d1401d54b05f6a40857eda7149
+  metadata.gz: a73e673298f094cc8c6947eb328f5b6c0a86f06ff2cc73d341ce98493adde571b3fd282cfce152b6724c6cb652acce7e632a831f0ccea3a09dad816db06cbd38
+  data.tar.gz: 6d1b9d93e7bae26a96b043b92cc5b896876c6d250b0cf35b981e9aec945ca8d8b5bd142954705a017d63da7f8c5e71170ddecf4f2a08b95c05d6974db3b9ec91

data/.travis.yml

@@ -8,11 +8,11 @@ script:
 after_script:
   - bundle exec codeclimate-test-reporter
 rvm:
-  - 2.1
+  - 2.4.0
+  - 2.3
   - 2.2
-  - 2.3.0
   - rbx-3
-  - jruby-9000
+  - jruby-9.1.6.0
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.7.0 - 2017-06-16
+
+### Changed
+
+- [BREAKING] `Dry::Web::Settings` now loads settings from local `.env` and `.env.<environment>` files (GustavoCaso)
+- [BREAKING] Removed `Dry::Web::Umbrella` with special handling of settings. Settings should for now be provided as a bootable component within your applications (dry-web-roda will be updated to generate such) (timriley)
+
 # 0.6.0 - 2017-02-02
 
 ### Added

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discuss.dry-rb.org](https://discuss.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discuss.dry-rb.org](http://discuss.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discuss.dry-rb.org](https://discuss.dry-rb.org).

data/lib/dry/web/settings.rb

@@ -1,4 +1,4 @@
-require "yaml"
+require "dry/web/settings/file_loader"
 
 module Dry
   module Web
@@ -27,16 +27,20 @@ module Dry
       end
       private_class_method :check_schema_duplication
 
+      def self.load_files(root, env)
+        FileLoader.new.(root, env)
+      end
+      private_class_method :load_files
+
       def self.load(root, env)
-        yaml_path = root.join("config/settings.yml")
-        yaml_data = File.exist?(yaml_path) ? YAML.load_file(yaml_path)[env.to_s] : {}
+        env_data = load_files(root, env)
         schema = self.schema
 
         Class.new do
           extend Dry::Configurable
 
           schema.each do |key, type|
-            value = ENV.fetch(key.to_s.upcase) { yaml_data[key.to_s.downcase] }
+            value = ENV.fetch(key.to_s.upcase) { env_data[key.to_s.upcase] }
 
             begin
               value = type[value] if type

data/lib/dry/web/settings/file_loader.rb

@@ -0,0 +1,28 @@
+require "dry/web/settings/file_parser"
+
+module Dry
+  module Web
+    class Settings
+      class FileLoader
+        def call(root, env)
+          files(root, env).reduce({}) do |hash, file|
+            hash.merge(parser.(file))
+          end
+        end
+
+        private
+
+        def parser
+          @parser ||= FileParser.new
+        end
+
+        def files(root, env)
+          [
+            root.join(".env"),
+            root.join(".env.#{env}")
+          ].compact
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/settings/file_parser.rb

@@ -0,0 +1,49 @@
+module Dry
+  module Web
+    class Settings
+      class FileParser
+        # Regex extracted from dotenv gem
+        # https://github.com/bkeepers/dotenv/blob/master/lib/dotenv/parser.rb#L14
+        LINE = %r(
+          \A
+          \s*
+          (?:export\s+)?    # optional export
+          ([\w\.]+)         # key
+          (?:\s*=\s*|:\s+?) # separator
+          (                 # optional value begin
+            '(?:\'|[^'])*'  #   single quoted value
+            |               #   or
+            "(?:\"|[^"])*"  #   double quoted value
+            |               #   or
+            [^#\n]+         #   unquoted value
+          )?                # value end
+          \s*
+          (?:\#.*)?         # optional comment
+          \z
+        )x
+
+        def call(file)
+          File.readlines(file).each_with_object({}) do |line, hash|
+            parse_line(line, hash)
+          end
+        rescue Errno::ENOENT
+          {}
+        end
+
+        private
+
+        def parse_line(line, hash)
+          if (match = line.match(LINE))
+            key, value = match.captures
+            hash[key] = parse_value(value || "")
+          end
+          hash
+        end
+
+        def parse_value(value)
+          value.strip.sub(/\A(['"])(.*)\1\z/, '\2')
+        end
+      end
+    end
+  end
+end

data/lib/dry/web/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Web
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/spec/fixtures/multiple_env_files/.env

@@ -0,0 +1,2 @@
+IN_BOTH_ENVIRONMENT='.env'
+ONLY_ON_ENV='will be loaded from env'

data/spec/fixtures/multiple_env_files/.env.test

@@ -0,0 +1,2 @@
+IN_BOTH_ENVIRONMENT='.env.test'
+ONLY_IN_TEST='will be loaded from env.test'

data/spec/fixtures/test/.env.test

@@ -0,0 +1,5 @@
+API_KEY='yaml123'
+IN_BOTH_ENVIRONMENT='.env.test'
+PRECOMPILE_ASSETS="1"
+UNDECLARED=not declared in settings
+TESTING='variables with = in it'

data/spec/unit/settings/file_loader_spec.rb

@@ -0,0 +1,16 @@
+require "dry/web/settings/file_loader"
+
+RSpec.describe Dry::Web::Settings::FileLoader do
+  let(:klass) { Dry::Web::Settings::FileLoader }
+  let(:root) { SPEC_ROOT.join("fixtures/multiple_env_files") }
+  let(:env) { :test }
+  subject(:data) { klass.new.(root, env)  }
+
+  describe "#call" do
+    it "will create hash with both variables from files" do
+      expect(subject["ONLY_ON_ENV"]).to eq ("will be loaded from env")
+      expect(subject["ONLY_IN_TEST"]).to eq ("will be loaded from env.test")
+      expect(subject["IN_BOTH_ENVIRONMENT"]).to eq (".env.test")
+    end
+  end
+end

data/spec/unit/settings/file_parser_spec.rb

@@ -0,0 +1,29 @@
+require "dry/web/settings/file_parser"
+
+RSpec.describe Dry::Web::Settings::FileParser do
+  let(:klass) { Dry::Web::Settings::FileParser }
+  let(:parser) { klass.new  }
+
+  describe "#call" do
+    context "with existing file" do
+      let(:file) { SPEC_ROOT.join("fixtures/test/.env.test") }
+      subject(:settings) { parser.(file) }
+
+      it "will retrun a hash with all variables and its value" do
+        expect(subject["API_KEY"]).to eq ("yaml123")
+        expect(subject["PRECOMPILE_ASSETS"]).to eq ("1")
+        expect(subject["UNDECLARED"]).to eq ("not declared in settings")
+        expect(subject["TESTING"]).to eq ("variables with = in it")
+      end
+    end
+
+    context "without existing file" do
+      let(:file) { SPEC_ROOT.join("fixtures/test/.env") }
+      subject(:settings) { parser.(file) }
+
+      it "will retrun a empty hash" do
+        expect(subject).to eq ({})
+      end
+    end
+  end
+end

data/spec/unit/settings_spec.rb

@@ -26,14 +26,39 @@ RSpec.describe Dry::Web::Settings do
       expect(settings.env_only_setting).to eq "hello"
     end
 
-    it "loads settings from a YAML file (as lower-cased keys) if unavailable from ENV" do
+    it "loads settings from a env file (as upper-cased keys) if unavailable from ENV" do
       expect(settings.api_key).to eq "yaml123"
     end
 
-    it "ignores undeclared settings in the YAML file" do
+    it "ignores undeclared settings in the env file" do
       expect(settings).not_to respond_to(:undeclared)
     end
 
+    context "without file" do
+      subject(:settings) {
+        Class.new(Dry::Web::Settings) do
+          setting :api_key
+          setting :precompile_assets
+        end.load(SPEC_ROOT.join("fixtures/test"), :development)
+      }
+
+      it "will retrun an config hash " do
+        expect(settings.to_h).to eq ({api_key: nil, precompile_assets: nil})
+      end
+    end
+
+    context "specific env file will merge on top of `.env`" do
+      subject(:settings) {
+        Class.new(Dry::Web::Settings) do
+          setting :in_both_environment
+        end.load(SPEC_ROOT.join("fixtures/multiple_env_files"), :test)
+      }
+
+      it "will retrun the value set from the test env " do
+        expect(settings.in_both_environment).to eq ".env.test"
+      end
+    end
+
     context "settings with types" do
       before do
         Test::CoercingBool = Class.new do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-web
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-system
@@ -105,6 +105,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -114,15 +115,19 @@ files:
 - lib/dry/web/console.rb
 - lib/dry/web/container.rb
 - lib/dry/web/settings.rb
-- lib/dry/web/umbrella.rb
+- lib/dry/web/settings/file_loader.rb
+- lib/dry/web/settings/file_parser.rb
 - lib/dry/web/version.rb
 - log/.gitkeep
-- spec/fixtures/test/config/settings.yml
+- spec/fixtures/multiple_env_files/.env
+- spec/fixtures/multiple_env_files/.env.test
+- spec/fixtures/test/.env.test
 - spec/fixtures/test/log/.gitkeep
 - spec/spec_helper.rb
 - spec/unit/container_spec.rb
+- spec/unit/settings/file_loader_spec.rb
+- spec/unit/settings/file_parser_spec.rb
 - spec/unit/settings_spec.rb
-- spec/unit/umbrella_spec.rb
 homepage: https://github.com/dry-rb/dry-web
 licenses:
 - MIT
@@ -143,14 +148,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Lightweight web application stack on top of dry-system
 test_files:
-- spec/fixtures/test/config/settings.yml
+- spec/fixtures/multiple_env_files/.env
+- spec/fixtures/multiple_env_files/.env.test
+- spec/fixtures/test/.env.test
 - spec/fixtures/test/log/.gitkeep
 - spec/spec_helper.rb
 - spec/unit/container_spec.rb
+- spec/unit/settings/file_loader_spec.rb
+- spec/unit/settings/file_parser_spec.rb
 - spec/unit/settings_spec.rb
-- spec/unit/umbrella_spec.rb

data/lib/dry/web/umbrella.rb

@@ -1,33 +0,0 @@
-require "dry/web/container"
-
-module Dry
-  module Web
-    class Umbrella < Dry::Web::Container
-      setting :settings_loader
-      setting :settings
-
-      def self.configure(env = config.env, &block)
-        super() do |config|
-          yield(config) if block
-
-          if config.settings_loader && config.settings.nil?
-            config.settings = load_settings(config.settings_loader, root, env)
-          end
-        end
-
-        self
-      end
-
-      def self.load_settings(loader, root, env)
-        begin
-          loader.load(root, env)
-        rescue => e
-          puts "Could not load your settings: #{e}"
-          puts
-          raise e
-        end
-      end
-      private_class_method :load_settings
-    end
-  end
-end

data/spec/fixtures/test/config/settings.yml

@@ -1,4 +0,0 @@
-test:
-  api_key: "yaml123"
-  precompile_assets: "1"
-  undeclared: "not declared in settings"

data/spec/unit/umbrella_spec.rb

@@ -1,56 +0,0 @@
-require "dry/web/settings"
-require "dry/web/umbrella"
-
-RSpec.describe Dry::Web::Umbrella do
-  subject(:umbrella) {
-    Class.new(Dry::Web::Umbrella) do
-      configure do |config|
-        config.root = SPEC_ROOT.join("fixtures/test")
-      end
-    end
-  }
-
-  describe "config" do
-    describe "#settings" do
-      subject(:settings) { umbrella.config.settings }
-
-      context "no settings specified" do
-        it "is an empty object" do
-          expect(:settings).not_to be_nil
-        end
-
-        it "does not offer any settings" do
-          expect(:settings).not_to respond_to(:some_setting)
-        end
-      end
-
-      context "settings loader specified" do
-        let(:settings_loader) { class_double("Dry::Web::Settings") }
-
-        it "loads the settings using the specified settings_loader" do
-          allow(settings_loader).to receive(:load).with(umbrella.config.root, :test) {
-            double("settings", foo: "bar")
-          }
-
-          umbrella.configure do |config|
-            config.settings_loader = settings_loader
-          end
-
-          expect(settings.foo).to eq "bar"
-        end
-      end
-
-      context "settings object specified" do
-        before do
-          umbrella.configure do |config|
-            config.settings = double("custom settings", bar: "baz")
-          end
-        end
-
-        it "leaves the settings object in place" do
-          expect(settings.bar).to eq "baz"
-        end
-      end
-    end
-  end
-end