tynn 1.4.0 → 2.0.0.alpha

data/lib/tynn/static.rb

@@ -1,35 +1,26 @@
+# frozen_string_literal: true
+
 class Tynn
-  # Public: Adds support for static files (javascript files, images,
-  # stylesheets, etc).
+  # Serves static files (javascript files, images, stylesheets, etc).
+  #
+  # By default, these files are served from the <tt>./public</tt> folder.
+  # A different location can be specified through the <tt>:root</tt> option.
   #
-  # Examples
+  # Under the hood, it uses the Rack::Static middleware.
+  # Thus, supports all the options available by the middleware.
   #
   #   require "tynn"
   #   require "tynn/static"
   #
   #   Tynn.plugin(Tynn::Static, ["/js", "/css"])
-  #
-  # By default, serves all requests beginning with the given paths from
-  # the folder +public+ in the current directory (e.g. +public/js/*+,
-  # +public/css/*+). You can change the default by passing the +:root+
-  # option.
-  #
-  # Examples
-  #
   #   Tynn.plugin(Tynn::Static, ["/js", "/css"], root: "assets")
-  #
-  # Under the hood, it uses the +Rack::Static+ middleware. Thus,
-  # supports all the options available by the middleware. Check
-  # {Rack::Static}[http://www.rubydoc.info/gems/rack/Rack/Static]
-  # for more information.
-  #
-  # Examples
-  #
   #   Tynn.plugin(Tynn::Static, ["/js", "/css"], index: "index.html")
   #
+  # For more information on the supported options, please see
+  # Rack::Static[http://www.rubydoc.info/gems/rack/Rack/Static].
+  #
   module Static
-    # Internal: Configures Rack::Static middleware.
-    def self.setup(app, urls, opts = {})
+    def self.setup(app, urls, opts = {}) # :nodoc:
       options = opts.dup
 
       options[:urls] ||= urls

data/lib/tynn/test.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 class Tynn
-  # Public: A simple helper class to simulate requests to your application.
-  #
-  # Examples
+  # A simple helper class to simulate requests to the application.
   #
   #   require "tynn"
   #   require "tynn/test"
   #
   #   Tynn.define do
   #     root do
-  #       res.write("hei")
+  #       res.write("Hei!")
   #     end
   #   end
   #
@@ -16,39 +16,29 @@ class Tynn
   #   app.get("/")
   #
   #   app.res.status # => 200
-  #   app.res.body   # => "hei"
+  #   app.res.body   # => "Hei!"
   #
   class Test
-    # Public: Initializes a new Tynn::Test object.
-    #
-    # app - The application class to test (default: Tynn).
-    #
-    # Examples
+    attr_reader :app # :nodoc:
+
+    # Initializes a new Tynn::Test object.
     #
     #   class API < Tynn
     #   end
     #
     #   app = Tynn::Test.new(API)
-    #   app.get("/json")
+    #   app.get("/user.json")
     #
     def initialize(app = Tynn)
       @app = app
     end
 
-    # Internal: Returns the application class that handles the
-    # mock requests. Required by Tynn::Test::InstanceMethods.
-    def app
-      return @app
-    end
-
-    # Internal: This module provides the Tynn::Test API methods.
-    # If you don't like the stand-alone version, you can integrate
-    # this module to your preferred testing environment.
-    #
-    # The following example uses Minitest:
+    # This module provides the Tynn::Test API methods. If the stand-alone
+    # version is not preferred, this module can be integrated into the
+    # testing environment. The following example uses Minitest:
     #
     #   class HomeTest < Minitest::Test
-    #     include Tynn::Test::InstanceMethods
+    #     include Tynn::Test::Methods
     #
     #     def app
     #       return Tynn
@@ -61,113 +51,99 @@ class Tynn
     #     end
     #   end
     #
-    module InstanceMethods
-      # Public: Returns the current request object or +nil+ if no requests
-      # have been issued yet.
-      #
-      # Examples
+    module Methods
+      # If a request has been issued, returns an instance of
+      # Rack::Request[http://www.rubydoc.info/gems/rack/Rack/Request].
+      # Otherwise, returns <tt>nil</tt>.
       #
       #   app = Tynn::Test.new
-      #   app.get("/", {}, { "HTTP_USER_AGENT" => "Tynn::Test" })
+      #   app.get("/", { foo: "foo" }, { "HTTP_USER_AGENT" => "Tynn::Test" })
       #
       #   app.req.get?
       #   # => true
       #
+      #   app.req.params["foo"]
+      #   # => "foo"
+      #
       #   app.req.env["HTTP_USER_AGENT"]
       #   # => "Tynn::Test"
       #
-      # The returned object is an instance of
-      # {Rack::Request}[http://www.rubydoc.info/gems/rack/Rack/Request].
-      #
       def req
         @__req
       end
 
-      # Public: Returns the current response object or +nil+ if no requests
-      # have been issued yet.
-      #
-      # Examples
+      # If a request has been issued, returns an instance of
+      # Rack::MockResponse[http://www.rubydoc.info/gems/rack/Rack/MockResponse].
+      # Otherwise, returns <tt>nil</tt>.
       #
       #   app = Tynn::Test.new
-      #   app.get("/", name: "alice")
+      #   app.get("/", name: "Jane")
       #
       #   app.res.status
       #   # => 200
       #
       #   app.res.body
-      #   # => "Hello alice!"
+      #   # => "Hello Jane!"
       #
-      # The returned object is an instance of
-      # {Rack::MockResponse}[http://www.rubydoc.info/gems/rack/Rack/MockResponse]
+      #   app.res["Content-Type"]
+      #   # => "text/html"
       #
       def res
         @__res
       end
 
-      # Public: Issues a GET request for the given +path+ with the given
-      # +params+ and Rack environment.
+      # Issues a <tt>GET</tt> request.
       #
-      # Examples
+      # [path]   A request path.
+      # [params] A Hash of query/post parameters, a String request body,
+      #          or <tt>nil</tt>.
+      # [env]    A Hash of Rack environment values.
       #
       #   app = Tynn::Test.new
-      #   app.get("/search", name: "alice")
+      #   app.get("/search", name: "jane")
+      #   app.get("/cart", {}, { "HTTPS" => "on" })
       #
       def get(path, params = {}, env = {})
-        request(path, env.merge(method: Rack::GET, params: params))
+        request(path, env.merge(method: "GET", params: params))
       end
 
-      # Public: Issues a POST request for the given +path+ with the given
-      # +params+ and Rack environment.
-      #
-      # Examples
+      # Issues a <tt>POST</tt> request. See #get for more information.
       #
       #   app = Tynn::Test.new
-      #   app.post("/signup", username: "alice", password: "secret")
+      #   app.post("/signup", username: "janedoe", password: "secret")
       #
       def post(path, params = {}, env = {})
-        request(path, env.merge(method: "POST".freeze, params: params))
+        request(path, env.merge(method: "POST", params: params))
       end
 
-      # Public: Issues a PUT request for the given +path+ with the given
-      # +params+ and Rack environment.
-      #
-      # Examples
+      # Issues a <tt>PUT</tt> request. See #get for more information.
       #
       #   app = Tynn::Test.new
-      #   app.put("/users/1", username: "bob", name: "Bob")
+      #   app.put("/users/1", username: "johndoe", name: "John")
       #
       def put(path, params = {}, env = {})
-        request(path, env.merge(method: "PUT".freeze, params: params))
+        request(path, env.merge(method: "PUT", params: params))
       end
 
-      # Public: Issues a PATCH request for the given +path+ with the given
-      # +params+ and Rack environment.
-      #
-      # Examples
+      # Issues a <tt>PATCH</tt> request. See #get for more information.
       #
       #   app = Tynn::Test.new
-      #   app.patch("/users/1", username: "alice")
+      #   app.patch("/users/1", username: "janedoe")
       #
       def patch(path, params = {}, env = {})
-        request(path, env.merge(method: "PATCH".freeze, params: params))
+        request(path, env.merge(method: "PATCH", params: params))
       end
 
-      # Public: Issues a DELETE request for the given +path+ with the given
-      # +params+ and Rack environment.
-      #
-      # Examples
+      # Issues a <tt>DELETE</tt> request. See #get for more information.
       #
       #   app = Tynn::Test.new
       #   app.delete("/users/1")
       #
       def delete(path, params = {}, env = {})
-        request(path, env.merge(method: "DELETE".freeze, params: params))
+        request(path, env.merge(method: "DELETE", params: params))
       end
 
-      # Public: Issues a HEAD request for the given +path+ with the given
-      # +params+ and Rack environment.
-      #
-      # Examples
+      # Issues a <tt>HEAD</tt> request. See #get for more information.
       #
       #   app = Tynn::Test.new
       #   app.head("/users/1")
@@ -176,16 +152,13 @@ class Tynn
         request(path, env.merge(method: Rack::HEAD, params: params))
       end
 
-      # Public: Issues a OPTIONS request for the given +path+ with the given
-      # +params+ and Rack environment.
-      #
-      # Examples
+      # Issues a <tt>OPTIONS</tt> request. See #get for more information.
       #
       #   app = Tynn::Test.new
       #   app.options("/users")
       #
       def options(path, params = {}, env = {})
-        request(path, env.merge(method: "OPTIONS".freeze, params: params))
+        request(path, env.merge(method: "OPTIONS", params: params))
       end
 
       private
@@ -196,6 +169,6 @@ class Tynn
       end
     end
 
-    include InstanceMethods
+    include Methods
   end
 end

data/lib/tynn/version.rb

@@ -1,8 +1,5 @@
-class Tynn # :nodoc: all
-  VERSION = [
-    MAJOR_VERSION = 1,
-    MINOR_VERSION = 4,
-    PATCH_VERSION = 0,
-    PRE_VERSION   = nil
-  ].compact.join(".")
+# frozen_string_literal: true
+
+class Tynn
+  VERSION = "2.0.0.alpha" # :nodoc:
 end

data/test/default_headers_test.rb

@@ -1,14 +1,26 @@
-test "default headers" do
-  Tynn.set(:default_headers, "Content-Type" => "text/plain")
+# frozen_string_literal: true
 
-  Tynn.define do
-    root do
-      res.write("hei")
-    end
+require_relative "helper"
+
+class DefaultHeadersTest < Minitest::Test
+  def setup
+    @app = Class.new(Tynn)
+  end
+
+  def test_set_and_get_headers
+    @app.set(:default_headers, "Content-Type" => "text/plain")
+
+    assert_equal "text/plain", @app.default_headers["Content-Type"]
   end
 
-  app = Tynn::Test.new(Tynn)
-  app.get("/")
+  def test_respond_with_headers
+    @app.set(:default_headers, "Content-Type" => "text/plain")
 
-  assert_equal "text/plain", app.res.headers["Content-Type"]
+    @app.define {}
+
+    ts = Tynn::Test.new(@app)
+    ts.get("/")
+
+    assert_equal @app.default_headers, ts.res.headers
+  end
 end

data/test/environment_test.rb

@@ -1,27 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "helper"
 require_relative "../lib/tynn/environment"
 
-test "use RACK_ENV by default" do
-  begin
-    old, ENV["RACK_ENV"] = ENV["RACK_ENV"], "production"
+class EnvironmentTest < Minitest::Test
+  def setup
+    @app = Class.new(Tynn)
+  end
+
+  def test_without_rack_env
+    env, ENV["RACK_ENV"] = ENV.to_h, nil
 
-    Tynn.plugin(Tynn::Environment)
+    @app.plugin(Tynn::Environment)
+
+    assert_equal :development, @app.environment
+  ensure
+    ENV.replace(env)
+  end
 
-    assert_equal(:production, Tynn.environment)
+  def test_with_rack_env
+    env, ENV["RACK_ENV"] = ENV.to_h, "test"
 
-    assert !Tynn.development?
-    assert !Tynn.test?
-    assert Tynn.production?
+    @app.plugin(Tynn::Environment)
 
+    assert_equal :test, @app.environment
   ensure
-    ENV["RACK_ENV"] = old
+    ENV.replace(env)
   end
-end
 
-test "use custom value" do
-  Tynn.plugin(Tynn::Environment, env: "development")
+  def test_set_environment
+    @app.plugin(Tynn::Environment, env: :development)
+
+    @app.set(:environment, :test)
+
+    assert_equal :test, @app.environment
+  end
 
-  assert_equal(:development, Tynn.environment)
-  assert Tynn.development?
-  assert !Tynn.test?
-  assert !Tynn.production?
+  def test_predicate_methods
+    @app.plugin(Tynn::Environment, env: :development)
+
+    assert_equal true, @app.development?
+    assert_equal false, @app.production?
+    assert_equal false, @app.test?
+    assert_equal false, @app.staging?
+  end
+
+  def test_configure
+    @app.plugin(Tynn::Environment)
+
+    @app.set(:environment, :test)
+
+    @app.configure(:test) do
+      @app.set(:test, true)
+    end
+
+    @app.configure(:development, :test) do |app|
+      app.set(:production, false)
+    end
+
+    @app.configure(:production) do
+      raise "This should not be executed"
+    end
+
+    assert_equal true, @app.settings[:test]
+    assert_equal false, @app.settings[:production]
+  end
 end

data/test/helper.rb

@@ -1,9 +1,7 @@
-$VERBOSE = true
+# frozen_string_literal: true
 
-require "cutest"
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
 require_relative "../lib/tynn"
 require_relative "../lib/tynn/test"
-
-prepare do
-  Tynn.reset!
-end

data/test/json_test.rb

@@ -1,19 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "helper"
 require_relative "../lib/tynn/json"
 
-test "json" do
-  Tynn.plugin(Tynn::JSON)
+class JSONTest < Minitest::Test
+  def setup
+    @app = Class.new(Tynn)
+  end
+
+  def test_respond_json_object
+    @app.plugin(Tynn::JSON)
 
-  Tynn.define do
-    root do
-      json(name: "tynn")
+    @app.define do
+      get do
+        json(foo: "foo")
+      end
     end
+
+    ts = Tynn::Test.new(@app)
+    ts.get("/")
+
+    object = JSON.parse(ts.res.body)
+
+    assert_equal "foo", object["foo"]
   end
 
-  app = Tynn::Test.new
-  app.get("/")
+  def test_respond_json_array
+    @app.plugin(Tynn::JSON)
+
+    @app.define do
+      get do
+        json(%w(foo bar baz))
+      end
+    end
 
-  json = JSON.parse(app.res.body)
+    ts = Tynn::Test.new(@app)
+    ts.get("/")
 
-  assert_equal "tynn", json["name"]
-  assert_equal "application/json", app.res.headers["Content-Type"]
+    assert_equal %w(foo bar baz), JSON.parse(ts.res.body)
+  end
+
+  def test_content_type
+    @app.plugin(Tynn::JSON)
+
+    @app.define do
+      get do
+        json(ok: true)
+      end
+    end
+
+    ts = Tynn::Test.new(@app)
+    ts.get("/")
+
+    assert_equal "application/json", ts.res.content_type
+  end
 end