lita 3.3.1 → 4.0.0.rc1

data/spec/spec_helper.rb

@@ -11,9 +11,16 @@ require "lita"
 require "lita/cli"
 require "lita/rspec"
 
+Lita.version_3_compatibility_mode = false
+
 RSpec.configure do |config|
   config.mock_with :rspec do |mocks_config|
     mocks_config.verify_doubled_constant_names = true
     mocks_config.verify_partial_doubles = true
   end
+
+  config.before do
+    logger = double("Lita:Logger").as_null_object
+    allow(Lita).to receive(:logger).and_return(logger)
+  end
 end

data/templates/locales/en.yml

@@ -3,6 +3,15 @@ en:
     adapters:
       shell:
         startup_message: Type "exit" or "quit" to end the session.
+    auth:
+      class_method_deprecated: >-
+        Lita::Authorization.%{method} will be removed in Lita 5.0. Use the version accessed via
+        Lita::Robot#auth instead.
+    core:
+      register_adapter:
+        block_or_class_required: Lita.register_adapter requires a class in its two argument form.
+      register_handler:
+        block_or_class_required: Lita.register_handler requires a class in its single argument form.
     handlers:
       authorization:
         help:
@@ -38,9 +47,14 @@ en:
           part_key: part ROOM_ID
           part_value: Makes the robot part from the room with room ID ROOM_ID.
     adapter:
-      name_required: Adapters that are anonymous classes must define self.name.
       method_not_implemented: "This adapter has not implemented #%{method}."
       missing_configs: "The following keys are required on config.adapter: %{configs}"
+      require_config_deprecated: >-
+        Lita::Adapter.require_config is deprecated and will be removed in Lita 5.0.
+        Use Lita::Adapter.config instead.
+      required_configs_deprecated: >-
+        Lita::Adapter.required_configs is deprecated and will be removed in Lita 5.0.
+        Use Lita::Adapter.configuration instead.
     cli:
       no_gemfile_warning: >-
         The default command "start" must be run inside a Lita project. Try running `lita new` to
@@ -48,30 +62,68 @@ en:
       travis_question: Do you want to test your plugin on Travis CI?
       coveralls_question: |-
         Do you want to generate code coverage information with SimpleCov and Coveralls.io?
+      daemon_deprecated: >-
+        Lita's built-in daemonization is deprecated without replacement and will be removed in
+        Lita 5.0. Use your operating system's process manager instead.
     config:
+      adapter_deprecated:
+        config.adapter is deprecated and will be removed in Lita 5.0. Use config.adapters instead.
       exception: |
         Lita configuration file could not be processed. The exception was:
         %{message}
         Full backtrace:
         %{backtrace}
+      handler_default_config_deprecated: >-
+        Lita::Handler.default_config is deprecated and will be removed in Lita 5.0.
+        Use Lita::Handler.config instead. The method was found defined in the %{name} handler.
+      redis_struct_access_deprecated: >-
+        Struct-style access of config.redis is deprecated and will be removed in Lita 5.0.
+        config.redis is now a hash.
+      missing_required_adapter_attribute: >-
+        Configuration attribute "%{attribute}" is required for "%{adapter}" adapter.
+      missing_required_handler_attribute: >-
+        Configuration attribute "%{attribute}" is required for "%{handler}" handler.
     daemon:
       pid_exists: >-
         PID file exists at %{path}. Lita may already be running. Kill the existing process or
         remove the PID file and then start Lita.
       kill_failure: "Failed to kill existing Lita process %{pid}."
     handler:
-      name_required: Handlers that are anonymous classes must define self.name.
       dispatch: "Dispatching message to %{handler}#%{method}."
       exception: |
         %{handler} crashed. The exception was:
         %{message}
         Full backtrace:
         %{backtrace}
+    http:
+      exception: |
+        Lita's built-in web server could not be started. The exception was:
+        %{message}
+        Full backtrace:
+        %{backtrace}
+    plugin:
+      name_required: Plugins that are anonymous classes must set a namespace or define self.name.
+    redis:
+      exception: |
+        Lita could not connect to Redis. The exception was:
+        %{message}
+        Full backtrace:
+        %{backtrace}
     robot:
       unknown_adapter: "Unknown adapter: :%{adapter}."
     rspec:
       full_suite_required: Lita::RSpec requires both RSpec::Mocks and RSpec::Expectations.
       version_3_required: RSpec::Core 3 or greater is required to use Lita::RSpec.
+      rack_test_required: Rack::Test is required to use the `http` method of Lita::RSpec.
+      lita_3_compatibility_mode: >-
+        WARNING: Lita 3 compatibility mode is currently enabled. It is recommended that you disable
+        it by adding the following code to spec/spec_helper.rb:
+
+            require "lita/rspec"
+            Lita.version_3_compatibility_mode = false
+
+        This will ensure that your test suite works with all the changes introduced in Lita 4. The
+        compatibility mode will be removed in Lita 5.
       route_failure: |-
         Expected message "%{message}" to route to :%{route}, but didn't.
       negative_route_failure: |-
@@ -84,7 +136,7 @@ en:
         Expected triggering event "%{event}" to invoke :%{route}, but didn't.
       negative_event_subscription_failure: |-
         Expected triggering event "%{event}" not to invoke :%{route}, but did.
+      matcher_deprecated: >-
+        `%{old_method}` is deprecated and will be removed in Lita 5.0. Use `%{new_method}` instead.
     source:
       user_or_room_required: Either a user or a room is required.
-    user:
-      find_deprecated: Lita::User.find will be removed in Lita 4.0. Use Lita::User.create instead.

data/templates/plugin/gemspec.tt

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rspec", ">= 3.0.0"
   <%- if config[:coveralls] -%>
   spec.add_development_dependency "simplecov"

data/templates/plugin/spec/spec_helper.tt

@@ -10,3 +10,7 @@ SimpleCov.start { add_filter "/spec/" }
 <%- end -%>
 require "<%= config[:gem_name] %>"
 require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.0.0.rc1
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -269,27 +283,43 @@ files:
 - lib/lita/adapter.rb
 - lib/lita/adapters/shell.rb
 - lib/lita/authorization.rb
+- lib/lita/builder.rb
+- lib/lita/callback.rb
 - lib/lita/cli.rb
 - lib/lita/common.rb
 - lib/lita/config.rb
+- lib/lita/configurable.rb
+- lib/lita/configuration.rb
+- lib/lita/configuration_validator.rb
 - lib/lita/daemon.rb
+- lib/lita/default_configuration.rb
+- lib/lita/errors.rb
 - lib/lita/handler.rb
+- lib/lita/handler/chat_router.rb
+- lib/lita/handler/common.rb
+- lib/lita/handler/event_router.rb
+- lib/lita/handler/http_router.rb
 - lib/lita/handlers/authorization.rb
+- lib/lita/handlers/deprecation_check.rb
 - lib/lita/handlers/help.rb
 - lib/lita/handlers/info.rb
 - lib/lita/handlers/room.rb
+- lib/lita/http_callback.rb
 - lib/lita/http_route.rb
 - lib/lita/logger.rb
 - lib/lita/message.rb
+- lib/lita/namespace.rb
 - lib/lita/rack_app.rb
+- lib/lita/registry.rb
 - lib/lita/response.rb
 - lib/lita/robot.rb
 - lib/lita/route_validator.rb
 - lib/lita/rspec.rb
 - lib/lita/rspec/handler.rb
-- lib/lita/rspec/matchers/event_subscription_matcher.rb
+- lib/lita/rspec/matchers/chat_route_matcher.rb
+- lib/lita/rspec/matchers/deprecated.rb
+- lib/lita/rspec/matchers/event_route_matcher.rb
 - lib/lita/rspec/matchers/http_route_matcher.rb
-- lib/lita/rspec/matchers/route_matcher.rb
 - lib/lita/source.rb
 - lib/lita/timer.rb
 - lib/lita/user.rb
@@ -299,16 +329,24 @@ files:
 - spec/lita/adapter_spec.rb
 - spec/lita/adapters/shell_spec.rb
 - spec/lita/authorization_spec.rb
+- spec/lita/builder_spec.rb
 - spec/lita/config_spec.rb
+- spec/lita/configuration_spec.rb
+- spec/lita/configuration_validator_spec.rb
 - spec/lita/daemon_spec.rb
+- spec/lita/default_configuration_spec.rb
+- spec/lita/handler/chat_router_spec.rb
+- spec/lita/handler/common_spec.rb
+- spec/lita/handler/event_router_spec.rb
+- spec/lita/handler/http_router_spec.rb
 - spec/lita/handler_spec.rb
 - spec/lita/handlers/authorization_spec.rb
+- spec/lita/handlers/deprecation_check_spec.rb
 - spec/lita/handlers/help_spec.rb
 - spec/lita/handlers/info_spec.rb
 - spec/lita/handlers/room_spec.rb
 - spec/lita/logger_spec.rb
 - spec/lita/message_spec.rb
-- spec/lita/rack_app_spec.rb
 - spec/lita/response_spec.rb
 - spec/lita/robot_spec.rb
 - spec/lita/rspec_spec.rb
@@ -348,9 +386,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.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.2.2
@@ -361,16 +399,24 @@ test_files:
 - spec/lita/adapter_spec.rb
 - spec/lita/adapters/shell_spec.rb
 - spec/lita/authorization_spec.rb
+- spec/lita/builder_spec.rb
 - spec/lita/config_spec.rb
+- spec/lita/configuration_spec.rb
+- spec/lita/configuration_validator_spec.rb
 - spec/lita/daemon_spec.rb
+- spec/lita/default_configuration_spec.rb
+- spec/lita/handler/chat_router_spec.rb
+- spec/lita/handler/common_spec.rb
+- spec/lita/handler/event_router_spec.rb
+- spec/lita/handler/http_router_spec.rb
 - spec/lita/handler_spec.rb
 - spec/lita/handlers/authorization_spec.rb
+- spec/lita/handlers/deprecation_check_spec.rb
 - spec/lita/handlers/help_spec.rb
 - spec/lita/handlers/info_spec.rb
 - spec/lita/handlers/room_spec.rb
 - spec/lita/logger_spec.rb
 - spec/lita/message_spec.rb
-- spec/lita/rack_app_spec.rb
 - spec/lita/response_spec.rb
 - spec/lita/robot_spec.rb
 - spec/lita/rspec_spec.rb

data/lib/lita/rspec/matchers/event_subscription_matcher.rb

@@ -1,67 +0,0 @@
-module Lita
-  module RSpec
-    # A namespace to hold all of Lita's RSpec matchers.
-    module Matchers
-      # Used to complete an event subscription test chain.
-      class EventSubscriptionMatcher
-        attr_accessor :context, :event_name, :expectation
-        attr_reader :expected_route
-
-        def initialize(context, event_name, expectation: true)
-          self.context = context
-          self.event_name = event_name
-          self.expectation = expectation
-        end
-
-        # Sets an expectation that a handler method will or will not be called in
-        # response to a triggered event, then triggers the event.
-        # @param target_method_name [String, Symbol] The name of the method that
-        #   should or should not be triggered.
-        # @return [void]
-        def to(target_method_name)
-          self.expected_route = target_method_name
-
-          e = expectation
-          ev = event_name
-          i = i18n_key
-
-          context.instance_eval do
-            called = false
-            allow(subject).to receive(target_method_name) { called = true }
-            robot.trigger(ev)
-            expect(called).to be(e), I18n.t(i, event: ev, route: target_method_name)
-          end
-        end
-
-        private
-
-        def description_prefix
-          if expectation
-            "routes event"
-          else
-            "doesn't route event"
-          end
-        end
-
-        def expected_route=(route)
-          @expected_route = route
-          set_description
-        end
-
-        def i18n_key
-          if expectation
-            "lita.rspec.event_subscription_failure"
-          else
-            "lita.rspec.negative_event_subscription_failure"
-          end
-        end
-
-        def set_description
-          description = %(#{description_prefix} "#{event_name}")
-          description << " to :#{expected_route}" if expected_route
-          ::RSpec.current_example.metadata[:description] = description
-        end
-      end
-    end
-  end
-end

data/lib/lita/rspec/matchers/route_matcher.rb

@@ -1,69 +0,0 @@
-module Lita
-  module RSpec
-    # A namespace to hold all of Lita's RSpec matchers.
-    module Matchers
-      # Used to complete a chat routing test chain.
-      class RouteMatcher
-        attr_accessor :context, :expectation, :message_body
-        attr_reader :expected_route
-
-        def initialize(context, message_body, expectation: true)
-          self.context = context
-          self.message_body = message_body
-          self.expectation = expectation
-          set_description
-        end
-
-        # Sets an expectation that a route will or will not be triggered, then
-        # sends the message originally provided.
-        # @param route [Symbol] The name of the method that should or should not
-        #   be triggered.
-        # @return [void]
-        def to(route)
-          self.expected_route = route
-
-          e = expectation
-          b = message_body
-          i = i18n_key
-
-          context.instance_eval do
-            allow(Authorization).to receive(:user_in_group?).and_return(true)
-            called = false
-            allow(subject).to receive(route) { called = true }
-            send_message(b)
-            expect(called).to be(e), I18n.t(i, message: b, route: route)
-          end
-        end
-
-        private
-
-        def description_prefix
-          if expectation
-            "routes"
-          else
-            "doesn't route"
-          end
-        end
-
-        def expected_route=(route)
-          @expected_route = route
-          set_description
-        end
-
-        def i18n_key
-          if expectation
-            "lita.rspec.route_failure"
-          else
-            "lita.rspec.negative_route_failure"
-          end
-        end
-
-        def set_description
-          description = %(#{description_prefix} "#{message_body}")
-          description << " to :#{expected_route}" if expected_route
-          ::RSpec.current_example.metadata[:description] = description
-        end
-      end
-    end
-  end
-end

data/spec/lita/rack_app_spec.rb

@@ -1,92 +0,0 @@
-require "spec_helper"
-
-describe Lita::RackApp do
-  let(:handler_class) do
-    Class.new(Lita::Handler) do
-      http.get "web", :web
-      http.post "path/with/:id", :variable
-      http.link "foo", :foo
-      http.get "heres/*a/glob/in/a/path", :glob
-      http.get ":var/otherwise/identical/path", :constraint, var: /\d+/
-      http.get ":var/otherwise/identical/path", :no_constraint
-
-      def web(_request, response)
-        response.write("it worked")
-      end
-
-      def variable(request, response)
-        id = request.env["router.params"][:id]
-        response.write("id is #{id}")
-      end
-
-      def glob(request, response)
-        segments = request.env["router.params"][:a]
-        response.write(segments.join("/"))
-      end
-
-      def constraint(_request, response)
-        response.write("constraint")
-      end
-
-      def no_constraint(_request, response)
-        response.write("no constraint")
-      end
-
-      def self.name
-        "Lita::Handlers::Test"
-      end
-    end
-  end
-
-  let(:robot) { instance_double("Lita::Robot") }
-
-  before { allow(Lita).to receive(:handlers).and_return([handler_class]) }
-
-  subject { described_class.new(robot) }
-
-  it "responds to requests for simple paths" do
-    env = Rack::MockRequest.env_for("/web")
-    status, _headers, body_proxy = subject.call(env)
-    expect(status).to eq(200)
-    expect(body_proxy.body.first).to eq("it worked")
-  end
-
-  it "responds to requests with variable paths" do
-    env = Rack::MockRequest.env_for("/path/with/some_id", method: "POST")
-    status, _headers, body_proxy = subject.call(env)
-    expect(status).to eq(200)
-    expect(body_proxy.body.first).to eq("id is some_id")
-  end
-
-  it "responds to requests with globs in their paths" do
-    env = Rack::MockRequest.env_for("/heres/a/giant/glob/in/a/path")
-    status, _headers, body_proxy = subject.call(env)
-    expect(status).to eq(200)
-    expect(body_proxy.body.first).to eq("a/giant")
-  end
-
-  it "responds to requests with variable path constraints" do
-    env = Rack::MockRequest.env_for("/123/otherwise/identical/path")
-    status, _headers, body_proxy = subject.call(env)
-    expect(status).to eq(200)
-    expect(body_proxy.body.first).to eq("constraint")
-
-    env = Rack::MockRequest.env_for("/an/otherwise/identical/path")
-    status, _headers, body_proxy = subject.call(env)
-    expect(status).to eq(200)
-    expect(body_proxy.body.first).to eq("no constraint")
-  end
-
-  it "responds to HEAD requests for GET routes" do
-    env = Rack::MockRequest.env_for("/web", method: "HEAD")
-    status, _headers, body = subject.call(env)
-    expect(status).to eq(204)
-    expect(body).to be_empty
-  end
-
-  it "doesn't respond to HEAD requests for non-GET routes" do
-    env = Rack::MockRequest.env_for("/path/with/some_id", method: "HEAD")
-    status, _headers, _body = subject.call(env)
-    expect(status).to eq(405)
-  end
-end