dry-web 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c2ac79f0779539356bd7a516d6a35b72628770b
-  data.tar.gz: b674f6ce4607fb2e8131f0b215b056aea3bbf301
+  metadata.gz: 87f2f5f98072989367f2d0a59ccc9fe8cc4762c0
+  data.tar.gz: 50752d39dea5ded3839fba27c48eacc46db5035a
 SHA512:
-  metadata.gz: 3cae9a50a5b3679065712c7679abc5371a956590d9e8ba33dcd7e24a18e311c4087dc8431531db648f736a99343a2ca3311052148ae05a7df77ce3a2780d7535
-  data.tar.gz: 74be24c3d7003f2a661bbc706f80992fb775b538610e1cc6b37d564b0549a4678b0f68a923868c2431355aca3fd56dc08d3fc33ed4892af72622ad09d0c80ef8
+  metadata.gz: 04ecc1a070afefdcd7b15776fab6696e837e982df611aa51ed0580651d8c60abfe5cf3a7e85def62408b3619f2bd010feea1ac25f50ee3e23408975bc100d58c
+  data.tar.gz: fe7f4569e116734f26ba675ceb8cfa09b2b18bcfc6d0b3180e9220668ef073a9c40031747ecb39e362988a67d0c4d7440488a9f4986cae599c4c21fee2ed4655

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.3.0 / 2016-06-22
+
+### Added
+
+- Added an `Umbrella` subclass of `Dry::Web::Container`, intended to be a single, top-level wrapper around multiple sub-apps in a dry-web project (timriley)
+- Added `Dry::Web::Settings`, designed to work as an app's single, top-level settings object (timriley)
+- Added `env` config to `Dry::Web::Container`, moved across from dry-component (timriley)
+
+### Changed
+
+- Renamed `Dry::Web::Cli` to `Dry::Web::Console`, to make room for a real CLI in the future, starting with dry-web-roda (timriley)
+
 # v0.2.0 / 2016-06-12
 
 ### Changed

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem "dry-component", github: "dry-rb/dry-component", branch: "master"
+
 group :test do
   gem 'byebug', platform: :mri
   gem 'codeclimate-test-reporter'

data/dry-web.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "dry-component", "~> 0"
+  spec.add_runtime_dependency "dry-component"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 11.0"

data/lib/dry/web/{cli.rb → console.rb}

@@ -1,6 +1,6 @@
 module Dry
   module Web
-    class Cli
+    class Console
       REPL = begin
                require 'pry'
                Pry

data/lib/dry/web/settings.rb

@@ -0,0 +1,53 @@
+require "yaml"
+
+module Dry
+  module Web
+    class Settings
+      SettingValueError = Class.new(StandardError)
+
+      def self.schema
+        @schema ||= {}
+      end
+
+      def self.setting(name, type = nil)
+        settings(name => type)
+      end
+
+      def self.settings(new_schema)
+        check_schema_duplication(new_schema)
+        @schema = schema.merge(new_schema)
+
+        self
+      end
+
+      def self.check_schema_duplication(new_schema)
+        shared_keys = new_schema.keys & schema.keys
+
+        raise ArgumentError, "Setting :#{shared_keys.first} has already been defined" if shared_keys.any?
+      end
+      private_class_method :check_schema_duplication
+
+      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] : {}
+        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] }
+
+            begin
+              value = type[value] if type
+            rescue => e
+              raise SettingValueError, "error typecasting +#{key}+: #{e}"
+            end
+
+            setting key, value
+          end
+        end.config
+      end
+    end
+  end
+end

data/lib/dry/web/umbrella.rb

@@ -0,0 +1,33 @@
+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/lib/dry/web/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Web
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

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

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

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+ENV["RACK_ENV"] = "test"
+
 if RUBY_ENGINE == "ruby"
   require "codeclimate-test-reporter"
   CodeClimate::TestReporter.start

data/spec/unit/settings_spec.rb

@@ -0,0 +1,80 @@
+require "dry/web/settings"
+
+RSpec.describe Dry::Web::Settings do
+  describe ".setting" do
+    it "raises an error if a duplicate setting is specified" do
+      expect {
+        Class.new(Dry::Web::Settings) do
+          setting :foo
+          setting :foo
+        end
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe ".load" do
+    subject(:settings) {
+      Class.new(Dry::Web::Settings) do
+        setting :api_key
+        setting :precompile_assets
+        setting :env_only_setting
+      end.load(SPEC_ROOT.join("fixtures/test"), :test)
+    }
+
+    it "loads settings from ENV first (as upper-cased variables)" do
+      ENV["ENV_ONLY_SETTING"] = "hello"
+      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
+      expect(settings.api_key).to eq "yaml123"
+    end
+
+    it "ignores undeclared settings in the YAML file" do
+      expect(settings).not_to respond_to(:undeclared)
+    end
+
+    context "settings with types" do
+      before do
+        Test::CoercingBool = Class.new do
+          def self.[](val)
+            %w[1 true].include?(val.to_s)
+          end
+        end
+
+        Test::ConstraintNotMatched = Class.new(ArgumentError)
+
+        Test::LongString = Class.new do
+          def self.[](val)
+            raise Test::ConstraintNotMatched, "string must be 12 characters or longer" if val.length < 12
+          end
+        end
+      end
+
+      context "coercing types" do
+        subject(:settings) {
+          Class.new(Dry::Web::Settings) do
+            setting :precompile_assets, Test::CoercingBool
+          end.load(SPEC_ROOT.join("fixtures/test"), :test)
+        }
+
+        it "supports coercion input data" do
+          expect(settings.precompile_assets).to eq true
+        end
+      end
+
+      context "constraining types" do
+        subject(:settings) {
+          Class.new(Dry::Web::Settings) do
+            setting :api_key, Test::LongString
+          end.load(SPEC_ROOT.join("fixtures/test"), :test)
+        }
+
+        it "raises helpful exceptions if input data does not match constraints" do
+          expect { settings }.to raise_error(Dry::Web::Settings::SettingValueError)
+          expect { settings }.to raise_error(/error typecasting \+api_key\+/)
+        end
+      end
+    end
+  end
+end

data/spec/unit/umbrella_spec.rb

@@ -0,0 +1,56 @@
+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

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: dry-web
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -99,11 +99,16 @@ files:
 - Rakefile
 - dry-web.gemspec
 - lib/dry-web.rb
-- lib/dry/web/cli.rb
+- lib/dry/web/console.rb
 - lib/dry/web/container.rb
+- lib/dry/web/settings.rb
+- lib/dry/web/umbrella.rb
 - lib/dry/web/version.rb
+- spec/fixtures/test/config/settings.yml
 - spec/spec_helper.rb
 - spec/unit/container_spec.rb
+- spec/unit/settings_spec.rb
+- spec/unit/umbrella_spec.rb
 homepage: https://github.com/dry-rb/dry-web
 licenses:
 - MIT
@@ -129,5 +134,8 @@ signing_key:
 specification_version: 4
 summary: Lightweight web application stack on top of dry-component
 test_files:
+- spec/fixtures/test/config/settings.yml
 - spec/spec_helper.rb
 - spec/unit/container_spec.rb
+- spec/unit/settings_spec.rb
+- spec/unit/umbrella_spec.rb