rory 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87f7aad3ae233e7193f17c7766db1cc3c551793b
-  data.tar.gz: 8c5ac24faba7ab853b087af9dbea31100d966fc8
+  metadata.gz: 74194a9762b2ac9e360fc706885bc17bfb1820d5
+  data.tar.gz: 7343f3b2aa9ae9c24620bc786fefb7931b763d78
 SHA512:
-  metadata.gz: df8251d088994de0b6333c6ac67daa1c260aa69e7f8aee39f2b59a8234b68cfb096b301664d0c6440e0cf32173160cd5ba4ecd5ee7482d80a3613190148c21c1
-  data.tar.gz: 3146ba610b2b6e80178f417bbde883acfdb9a560f57aa85157a2db819d8140137fa8431299bc0e421ae05cf498788896f49d4738a0578de1677c5fe3f09f5c8d
+  metadata.gz: 8ec94f1abf69f20d707edaf075014bf9fc3e8dae628d57d0d95ed1262d2a4fd1d5a15599590abf911b3a1f221d99797526db54cac266ae8c4f5d7768424b9c10
+  data.tar.gz: c8bcbdac1f51336f161a8a0e0f74460f647cfa57eaf00bfe8f2d9fe05097b195882534b7473963f948fd53e56999d1075a2327a902364f3e15ae53cf5c2c9a9a

data/lib/rory/application.rb

@@ -2,9 +2,10 @@ require 'pathname'
 require 'rory/logger'
 require 'rory/request_id'
 require 'rory/route_mapper'
+require 'rory/middleware_stack'
+require 'rory/initializers'
 require 'rack/commonlogger'
-require_relative 'request_parameter_logger'
-
+require 'rory/request_parameter_logger'
 
 module Rory
   # Main application superclass.  Applications should subclass this class,
@@ -30,7 +31,12 @@ module Rory
         instance.send(*args, &block)
       end
 
-      def respond_to?(method)
+      # @return [Rory::Initializers]
+      def initializers
+        @initializers ||= Initializers.new
+      end
+
+      def respond_to?(method, private=false)
         return true if instance.respond_to?(method)
         super
       end
@@ -42,8 +48,16 @@ module Rory
       def root=(root_path)
         $:.unshift @root = Pathname.new(root_path).realpath
       end
+
+      def initializer_default_middleware
+        Rory::Application.initializers.add "rory.request_middleware" do |app|
+          app.request_middleware
+        end
+      end
     end
 
+    initializer_default_middleware
+
     def auto_require_paths
       @auto_require_paths ||= %w(models controllers helpers)
     end
@@ -102,12 +116,11 @@ module Rory
     end
 
     def use_middleware(*args, &block)
-      @stack = nil
-      middleware << [args, block]
+      middleware.use *args, &block
     end
 
     def middleware
-      @middleware ||= []
+      @middleware ||= MiddlewareStack.new
     end
 
     def dispatcher
@@ -136,20 +149,27 @@ module Rory
       @stack = nil
     end
 
-    def use_default_middleware
-      if request_logging_on?
-        use_middleware Rory::RequestId, :uuid_prefix => self.class.name
-        use_middleware Rack::PostBodyContentTypeParser
-        use_middleware Rack::CommonLogger, logger
-        use_middleware Rory::RequestParameterLogger, logger, :filters => parameters_to_filter
-      end
+    def uuid_prefix
+      Support.tokenize(self.class.name.gsub("::Application", ""))
+    end
+
+    def request_middleware
+      return unless request_logging_on?
+      use_middleware Rory::RequestId, :uuid_prefix => uuid_prefix
+      use_middleware Rack::PostBodyContentTypeParser
+      use_middleware Rack::CommonLogger, logger
+      use_middleware Rory::RequestParameterLogger, logger, :filters => parameters_to_filter
+    end
+
+    def run_initializers
+      Rory::Application.initializers.run(self)
     end
 
     def stack
       @stack ||= Rack::Builder.new.tap { |builder|
-        use_default_middleware
-        middleware.each do |args, block|
-          builder.use *args, &block
+        run_initializers
+        middleware.each do |m|
+          builder.use m.klass, *m.args, &m.block
         end
         builder.run dispatcher
       }

data/lib/rory/initializers.rb

@@ -0,0 +1,81 @@
+module Rory
+  class Initializers
+    class Initializer
+      attr_reader :name, :block
+
+      def initialize(name, block)
+        @name = name
+        @block = block
+      end
+
+      def ==(initializer)
+        name == initializer.name
+      end
+
+      def inspect
+       "<Initializer '#{name}'>"
+      end
+
+      def call(app)
+        block.call(app)
+      end
+    end
+
+    include Enumerable
+    extend Forwardable
+    attr_accessor :initializers
+    def_delegators :initializers, :each, :clear, :size, :last, :first, :[]
+
+    def initialize
+      @initializers = []
+      yield(self) if block_given?
+    end
+
+    def unshift(name, &block)
+      initializers.unshift(build_initializer(name, block))
+    end
+
+    def insert(index, name, &block)
+      index = assert_index(index, :before)
+      initializers.insert(index, build_initializer(name, block))
+    end
+
+    alias_method :insert_before, :insert
+
+    def insert_after(index, name, &block)
+      index = assert_index(index, :after)
+      insert(index + 1, name, &block)
+    end
+
+    def delete(target)
+      initializers.delete_if { |m| m.name == target }
+    end
+
+    def add(name, &block)
+      initializers.push(build_initializer(name, block))
+    end
+
+    def run(app)
+      initializers.map{|i| i.call(app)}
+    end
+
+    private
+
+    def assert_index(index, where)
+      i     = index.is_a?(Integer) ? index : initializers.index { |m| m.name == index }
+      raise "No such initializer to insert #{where}: #{index.inspect}" unless i
+      i
+    end
+
+    def build_initializer(name, block)
+      Initializer.new(name, block).tap{ |i| assert_unique_name(i) }
+    end
+
+    def assert_unique_name(i)
+      unless (conflict = @initializers.select{|ii| ii == i}).empty?
+        raise "Initializer name: '#{i.name}' is already used. #{conflict.first.block}"
+      end
+    end
+  end
+end
+

data/lib/rory/middleware_stack.rb

@@ -0,0 +1,85 @@
+module Rory
+  class MiddlewareStack
+    class Middleware
+      attr_reader :args, :block, :klass
+
+      def initialize(klass, args, block)
+        @klass = klass
+        @args  = args
+        @block = block
+      end
+
+      def name;
+        klass.name;
+      end
+
+      def ==(middleware)
+        case middleware
+        when Middleware
+          klass == middleware.klass
+        when Class
+          klass == middleware
+        end
+      end
+
+      def inspect
+        if klass.is_a?(Class)
+          klass.to_s
+        else
+          klass.class.to_s
+        end
+      end
+
+      def build(app)
+        klass.new(app, *args, &block)
+      end
+    end
+
+    include Enumerable
+    extend Forwardable
+    attr_accessor :middlewares
+    def_delegators :middlewares, :each, :clear, :size, :last, :first, :[]
+
+    def initialize(on_change: -> {})
+
+      @middlewares = []
+      yield(self) if block_given?
+    end
+
+    def unshift(klass, *args, &block)
+      middlewares.unshift(build_middleware(klass, args, block))
+    end
+
+    def insert(index, klass, *args, &block)
+      index = assert_index(index, :before)
+      middlewares.insert(index, build_middleware(klass, args, block))
+    end
+
+    alias_method :insert_before, :insert
+
+    def insert_after(index, *args, &block)
+      index = assert_index(index, :after)
+      insert(index + 1, *args, &block)
+    end
+
+    def delete(target)
+      middlewares.delete_if { |m| m.klass == target }
+    end
+
+    def use(klass, *args, &block)
+      middlewares.push(build_middleware(klass, args.compact, block))
+    end
+
+    private
+
+    def assert_index(index, where)
+      i     = index.is_a?(Integer) ? index : middlewares.index { |m| m.klass == index }
+      raise "No such middleware to insert #{where}: #{index.inspect}" unless i
+      i
+    end
+
+    def build_middleware(klass, args, block)
+      Middleware.new(klass, args, block)
+    end
+  end
+end

data/lib/rory/request_id.rb

@@ -34,7 +34,7 @@ module Rory
     end
 
     def uuid_prefix
-      @uuid_prefix ? "#{Support.tokenize(@uuid_prefix)}-" : ""
+      @uuid_prefix ? "#{@uuid_prefix}-" : ""
     end
   end
 end

data/lib/rory/version.rb

@@ -1,3 +1,3 @@
 module Rory
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/lib/tasks/rory.rake

@@ -6,6 +6,17 @@ namespace :rory do
     command = ARGV.shift
     IRB.start
   end
+
+  desc "List out middleware stack in load order"
+  task :middleware => :environment do
+    Rory.application.run_initializers
+    puts Rory.application.middleware.map(&:klass).map(&:to_s).join("\n")
+  end
+
+  desc "List out initializers in load order"
+  task :initializers => :environment do
+    puts Rory::Application.initializers.map(&:name).join("\n")
+  end
 end
 
 namespace :log do
@@ -23,4 +34,4 @@ task :tasks do
     { 'name' => t.name, 'location' => t.locations }
   }
   puts tasks
-end
+end

data/rory.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.name = "rory"
   s.version = Rory::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["Ravi Gadad", "Michael Irey", "David Begin"]
+  s.authors = ["Ravi Gadad", "Michael Irey", "David Begin", "Dustin Zeisler"]
   s.email = ["ravi@screamingmuse.com"]
   s.homepage = "http://github.com/screamingmuse/rory"
   s.summary = "Another Ruby web framework. Just what the world needs."
@@ -19,7 +19,7 @@ Rails design decisions.
 
 See http://github.com/screamingmuse/rory for more info.
 EOF
-  s.required_ruby_version     = ">= 1.8.7"
+  s.required_ruby_version     = ">= 2.1.5"
   s.required_rubygems_version = ">= 1.3.6"
 
   s.extra_rdoc_files = ["LICENSE.txt", "README.md"]

data/spec/lib/rory/application_spec.rb

@@ -1,4 +1,6 @@
-describe Rory::Application do
+require_relative '../../fixture_app/lib/dummy_middleware'
+
+RSpec.describe Rory::Application do
   let(:subject) {
     Object.const_set(test_rory_app_name, Class.new(Rory::Application).tap { |app|
       app.root = root
@@ -12,6 +14,11 @@ describe Rory::Application do
   }
   let(:root){"spec/fixture_app"}
 
+  before do
+    Rory::Application.initializers.clear
+    Rory::Application.initializer_default_middleware
+  end
+
   describe ".root=" do
     let(:root) { "current_app" }
     before { `ln -s spec/fixture_app current_app` }
@@ -165,7 +172,7 @@ describe Rory::Application do
         and_return(:the_dispatcher)
       allow(Rack::Builder).to receive(:new).and_return(builder)
       subject.use_middleware :horse
-      expect(subject.instance).to receive(:use_default_middleware)
+      expect(subject.instance).to receive(:request_middleware).with(no_args)
       expect(builder).to receive(:use).with(:horse)
       expect(builder).to receive(:run).with(:the_dispatcher)
       expect(subject.stack).to eq(builder)
@@ -183,17 +190,17 @@ describe Rory::Application do
       allow(subject.instance).to receive(:request_logging_on?).and_return(true)
       allow(subject.instance).to receive(:parameters_to_filter).and_return([:horses])
       allow(subject.instance).to receive(:logger).and_return(:the_logger)
-      expect(subject.instance).to receive(:use_middleware).with(Rory::RequestId, :uuid_prefix => test_rory_app_name)
+      expect(subject.instance).to receive(:use_middleware).with(Rory::RequestId, :uuid_prefix => Rory::Support.tokenize(test_rory_app_name))
       expect(subject.instance).to receive(:use_middleware).with(Rack::PostBodyContentTypeParser)
       expect(subject.instance).to receive(:use_middleware).with(Rack::CommonLogger, :the_logger)
       expect(subject.instance).to receive(:use_middleware).with(Rory::RequestParameterLogger, :the_logger, :filters => [:horses])
-      subject.use_default_middleware
+      subject.request_middleware
     end
 
     it "does not add middleware when request logging is off" do
       allow(subject.instance).to receive(:request_logging_on?).and_return(false)
       expect(subject.instance).to receive(:use_middleware).never
-      subject.use_default_middleware
+      subject.request_middleware
     end
   end
 
@@ -254,7 +261,7 @@ describe Rory::Application do
 
   describe '.use_middleware' do
     it 'adds the given middleware to the stack, retaining args and block' do
-      require_relative '../../fixture_app/lib/dummy_middleware'
+
       subject.use_middleware DummyMiddleware, :puppy do |dm|
         dm.prefix = 'a salubrious'
       end
@@ -291,4 +298,56 @@ describe Rory::Application do
       end
     end
   end
+
+  describe ".initializers" do
+    describe ".insert_after" do
+      it "inserts initializer before another" do
+        probe = []
+        Rory::Application.initializers.add("insert_after.A") { probe << "insert_after.A" }
+        Rory::Application.initializers.add("insert_after.B") { probe << "insert_after.B" }
+        Rory::Application.initializers.insert_after("insert_after.A", "insert_after.C") { probe << "insert_after.C" }
+
+        expect { subject.run_initializers }.to change { probe }.from([]).
+          to(%w(insert_after.A insert_after.C insert_after.B))
+      end
+    end
+
+    describe ".add" do
+      it "runs the code inside any initializer block" do
+        probe = :initializers_not_run
+        Rory::Application.initializers.add "add.test" do
+          probe = :was_run
+        end
+        expect { subject.run_initializers }.to change { probe }.from(:initializers_not_run).to(:was_run)
+      end
+
+      it "passes the app instance to the block" do
+        probe = :block_not_called
+        Rory::Application.initializers.add "add.test_passes_app" do |app|
+          probe = :block_called
+          expect(app.class.superclass).to eq Rory::Application
+        end
+        expect { subject.run_initializers }.to change { probe }.from(:block_not_called).to(:block_called)
+      end
+    end
+  end
+
+  describe "#middleware" do
+    before { subject.middleware.clear }
+
+    describe "#insert_before" do
+      it "places the middleware order right after the given class" do
+        subject.instance.instance_variable_set(:@request_logging, :true)
+        Rory::Application.initializers.add "insert_before.dummy_middleware" do |app|
+          app.middleware.insert_before Rory::RequestId, DummyMiddleware, :puppy
+        end
+        subject.run_initializers
+        expect(subject.middleware.map(&:klass)).to eq [DummyMiddleware,
+                                                       Rory::RequestId,
+                                                       Rack::PostBodyContentTypeParser,
+                                                       Rack::CommonLogger,
+                                                       Rory::RequestParameterLogger]
+      end
+    end
+  end
 end

data/spec/lib/rory/initializers_spec.rb

@@ -0,0 +1,77 @@
+RSpec.describe Rory::Initializers do
+
+  describe "#unshift" do
+    it "adds an item to the front" do
+      subject.unshift("test.1unshift") {}
+      subject.unshift("test.2unshift") {}
+      expect(subject.initializers.map(&:name)).to eq %w(test.2unshift test.1unshift)
+    end
+  end
+
+  describe "#insert" do
+    it "adds an item before another" do
+      subject.add("test.1insert") {}
+      subject.insert("test.1insert", "test.2insert") {}
+      expect(subject.initializers.map(&:name)).to eq %w(test.2insert test.1insert)
+    end
+  end
+
+  describe "#insert_before" do
+    it "adds an item before another" do
+      subject.add("test.1insert_before") {}
+      subject.insert_before("test.1insert_before", "test.2insert_before") {}
+      expect(subject.initializers.map(&:name)).to eq %w(test.2insert_before test.1insert_before)
+    end
+  end
+
+  describe "#insert_after" do
+    it "adds an item at certain point after a given initializer" do
+      subject.add("test.1insert_after") {}
+      subject.add("test.2insert_after") {}
+      subject.insert_after("test.1insert_after", "test.3insert_after") {}
+      expect(subject.initializers.map(&:name)).to eq %w(test.1insert_after test.3insert_after test.2insert_after)
+    end
+  end
+
+  describe "#delete" do
+    it "removes a given initializer from loading" do
+      subject.add("test.delete") {}
+      subject.delete("test.delete")
+      expect(subject.initializers.map(&:name)).to eq []
+    end
+  end
+
+  describe "#add" do
+    it "push an item on the list to be loaded" do
+      subject.add("test.1add") {}
+      subject.add("test.2add") {}
+      expect(subject.initializers.map(&:name)).to eq %w(test.1add test.2add)
+    end
+
+    context "when two initializers have the same name" do
+      it "raises an error" do
+        subject.add("same_name_test") {}
+        expect{subject.add("same_name_test") {}}.to raise_error(/Initializer name: 'same_name_test' is already used./)
+      end
+    end
+  end
+
+  describe "#run" do
+    it "runs the initializers when given an app" do
+      probe = :block_not_run
+      subject.add("test.1add") { |app| probe = app }
+      subject.run(:this_is_the_app)
+      expect(probe).to eq :this_is_the_app
+    end
+  end
+
+  context "delegated array methods" do
+    [:each, :clear, :size, :last, :first].each do |meth|
+      it "##{meth}" do
+        expect(subject.initializers).to receive(meth)
+        subject.public_send(meth)
+      end
+    end
+  end
+end
+

data/spec/lib/rory/middleware_stack_spec.rb

@@ -0,0 +1,86 @@
+RSpec.describe Rory::MiddlewareStack do
+
+  let(:middleware_order) { subject.middlewares.map(&:klass).map(&:name) }
+
+  describe "#unshift" do
+    it "adds an item to the front" do
+      subject.unshift(double(name: "unshift1")) {}
+      subject.unshift(double(name: "unshift2"), 1, 2)
+
+      expect(middleware_order).to eq %w(unshift2 unshift1)
+    end
+  end
+
+  describe "#insert" do
+    it "adds an item to the end" do
+      insert1 = (double(name: "insert1"))
+      subject.use(insert1) {}
+      subject.insert(insert1, double(name: "insert2"), 1, 2)
+
+      expect(middleware_order).to eq %w(insert2 insert1)
+    end
+  end
+
+  describe "#insert_before" do
+    it "adds an item to the end" do
+      insert1 = (double(name: "insert_before1"))
+      subject.use(insert1) {}
+      subject.insert(insert1, double(name: "insert_before2"), 1, 2)
+
+      expect(middleware_order).to eq %w(insert_before2 insert_before1)
+    end
+  end
+
+  describe "#insert_after" do
+    it "adds an item at certain point after a given middleware" do
+      insert_after1 = double(name: "test.1insert_after")
+      subject.use(insert_after1) {}
+      subject.use(double(name: "test.2insert_after")) {}
+      subject.insert_after(insert_after1, double(name: "test.3insert_after")) {}
+      expect(middleware_order).to eq %w(test.1insert_after test.3insert_after test.2insert_after)
+    end
+  end
+
+  describe "#delete" do
+    it "removes a given middleware from loading" do
+      test_delete = double(name: "delete")
+      subject.use(test_delete)
+      subject.delete(test_delete)
+      expect(middleware_order).to eq []
+    end
+  end
+
+  describe "#use" do
+    it "push an item on the list to be loaded" do
+      subject.use(double(name: "use1")) {}
+      subject.use(double(name: "use2"), 1, 2)
+
+      expect(middleware_order).to eq %w(use1 use2)
+    end
+
+    it "arguments will be saved" do
+      subject.use(double(name: "use1")) {}
+      subject.use(double(name: "use2"), 1, 2)
+
+      expect(subject.middlewares.map(&:args)).to eq [[], [1, 2]]
+    end
+
+    it "blocks will be saved" do
+      probe = :block_not_called
+      subject.use(double(name: "use1")) {probe = :block_called}
+      subject.use(double(name: "use2"), 1, 2)
+      subject.middlewares.map(&:block).compact.map(&:call)
+      expect(probe).to eq :block_called
+    end
+  end
+
+  context "delegated array methods" do
+    [:each, :clear, :size, :last, :first].each do |meth|
+      it "##{meth}" do
+        expect(subject.middlewares).to receive(meth)
+        subject.public_send(meth)
+      end
+    end
+  end
+end
+

data/spec/lib/rory/request_id_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Rory::RequestId do
     end
 
     context "the uuid can be given a prefixed to know where it was created" do
-      let(:uuid_prefix) { "AppName" }
+      let(:uuid_prefix) { "app_name" }
       it { expect(Thread.current.get_inheritable_attribute(:rory_request_id)).to eq "app_name-1234" }
     end
   end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rory
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ravi Gadad
 - Michael Irey
 - David Begin
+- Dustin Zeisler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -229,7 +230,9 @@ files:
 - lib/rory/application.rb
 - lib/rory/controller.rb
 - lib/rory/dispatcher.rb
+- lib/rory/initializers.rb
 - lib/rory/logger.rb
+- lib/rory/middleware_stack.rb
 - lib/rory/parameter_filter.rb
 - lib/rory/path_generation.rb
 - lib/rory/renderer.rb
@@ -268,7 +271,9 @@ files:
 - spec/lib/rory/application_spec.rb
 - spec/lib/rory/controller_spec.rb
 - spec/lib/rory/dispatcher_spec.rb
+- spec/lib/rory/initializers_spec.rb
 - spec/lib/rory/logger_spec.rb
+- spec/lib/rory/middleware_stack_spec.rb
 - spec/lib/rory/parameter_filter_spec.rb
 - spec/lib/rory/renderer/context_spec.rb
 - spec/lib/rory/renderer_spec.rb
@@ -293,7 +298,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.1.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="