pliny 0.2.1 → 0.3.0

data/lib/pliny/templates/endpoint_scaffold.erb

@@ -6,7 +6,7 @@ module Endpoints
       end
 
       get do
-        MultiJson.encode <%= singular_class_name %>.all.map { |x| serialize(x) }
+        encode serialize(<%= singular_class_name %>.all)
       end
 
       post do
@@ -14,25 +14,25 @@ module Endpoints
         <%= field_name %> = <%= singular_class_name %>.new(body_params)
         <%= field_name %>.save
         status 201
-        MultiJson.encode serialize(<%= field_name %>)
+        encode serialize(<%= field_name %>)
       end
 
       get "/:id" do |id|
         <%= field_name %> = <%= singular_class_name %>.first(uuid: id) || halt(404)
-        MultiJson.encode serialize(<%= field_name %>)
+        encode serialize(<%= field_name %>)
       end
 
       patch "/:id" do |id|
         <%= field_name %> = <%= singular_class_name %>.first(uuid: id) || halt(404)
         # warning: not safe
         #<%= field_name %>.update(body_params)
-        MultiJson.encode serialize(<%= field_name %>)
+        encode serialize(<%= field_name %>)
       end
 
       delete "/:id" do |id|
         <%= field_name %> = <%= singular_class_name %>.first(uuid: id) || halt(404)
         <%= field_name %>.destroy
-        MultiJson.encode serialize(<%= field_name %>)
+        encode serialize(<%= field_name %>)
       end
 
       private

data/lib/pliny/templates/endpoint_scaffold_acceptance_test.erb

@@ -29,7 +29,7 @@ describe Endpoints::<%= plural_class_name %> do
   end
 
 =begin
-  describe 'POST <%= url_path %>/:id' do
+  describe 'POST <%= url_path %>' do
     it 'returns correct status code and conforms to schema' do
       header "Content-Type", "application/json"
       post '<%= url_path %>', MultiJson.encode({})

data/lib/pliny/templates/endpoint_test.erb

@@ -5,6 +5,7 @@ describe Endpoints::<%= plural_class_name %> do
 
   def app
     Endpoints::<%= plural_class_name %>
+
   end
 
   describe "GET <%= url_path %>" do

data/lib/pliny/templates/migration.erb

@@ -1,9 +1,7 @@
 Sequel.migration do
   up do
-    
   end
 
   down do
-    
   end
 end

data/lib/pliny/templates/model.erb

@@ -1,8 +1,6 @@
 class <%= singular_class_name %> < Sequel::Model
-
   plugin :timestamps
 <% if paranoid %>
   plugin :paranoid
 <% end %>
-
 end

data/lib/pliny/templates/model_test.erb

@@ -1,5 +1,4 @@
 require "spec_helper"
 
 describe <%= singular_class_name %> do
-  
 end

data/lib/pliny/templates/serializer_test.erb

@@ -1,5 +1,4 @@
 require "spec_helper"
 
 describe Serializers::<%= singular_class_name %> do
-  
 end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/template/.env.sample

@@ -1,6 +1,7 @@
 DATABASE_URL=postgres://localhost/pliny-development
 RACK_ENV=development
 TZ=UTC
-RESCUE_ERRORS=false
+RAISE_ERRORS=true
 FORCE_SSL=false
 TIMEOUT=false
+PRETTY_JSON=true

data/template/README.md

@@ -1,5 +1,5 @@
 # Pliny Template app
 
-This is the template app used by the [Pliny](https://github.com/12-oz/pliny) gem.
+This is the template app used by the [Pliny](https://github.com/interagent/pliny) gem.
 
 For more information please refer to the gem docs.

data/template/bin/console

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 
-require "bundler"
-Bundler.require
-require "./lib/initializer"
+require_relative '../lib/application'
 
 def basic_prompt(target_self, nest_level, pry)
   # override CONSOLE_BANNER to include something like a release identifier

data/template/bin/run

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-require "bundler"
-Bundler.require
-require "./lib/initializer"
+require_relative '../lib/application'
 
 eval ARGV.join(" ")

data/template/config.ru

@@ -1,7 +1,4 @@
-require "bundler"
-Bundler.require
-
-require "./lib/initializer"
+require_relative 'lib/application'
 
 $stdout.sync = true
 

data/template/config/config.rb

@@ -6,35 +6,29 @@ require "pliny/config_helpers"
 #
 # Each accessor corresponds directly to an ENV key, which has the same name
 # except upcased, i.e. `DATABASE_URL`.
-#
-# Note that *all* keys will come out as strings even if the override was a
-# different type. Make sure to typecast any values that need to be something
-# else (i.e. `.to_i`).
 module Config
-  extend Pliny::ConfigHelpers
+  extend Pliny::CastingConfigHelpers
 
   # Mandatory -- exception is raised for these variables when missing.
-  mandatory \
-    :database_url
+  mandatory :database_url, string
 
   # Optional -- value is returned or `nil` if it wasn't present.
-  optional \
-    :console_banner,
-    :placeholder,
-    :versioning_default,
-    :versioning_app_name
+  optional :console_banner,      string
+  optional :placeholder,         string
+  optional :versioning_default,  string
+  optional :versioning_app_name, string
 
-  # Override -- value is returned or the set default. Remember to typecast.
-  override \
-    db_pool:          5,
-    port:             5000,
-    puma_max_threads: 16,
-    puma_min_threads: 1,
-    puma_workers:     3,
-    rack_env:         'development',
-    raise_errors:     'false',
-    root:             File.expand_path("../../", __FILE__),
-    timeout:          45,
-    force_ssl:        'true',
-    versioning:       'false'
+  # Override -- value is returned or the set default.
+  override :db_pool,          5,    int
+  override :port,             5000, int
+  override :puma_max_threads, 16,   int
+  override :puma_min_threads, 1,    int
+  override :puma_workers,     3,    int
+  override :rack_env,         'development', string
+  override :raise_errors,     false,         bool
+  override :root,             File.expand_path("../../", __FILE__), string
+  override :timeout,          45,    int
+  override :force_ssl,        true,  bool
+  override :versioning,       false, bool
+  override :pretty_json,      false, bool
 end

data/template/config/initializers/rollbar.rb

@@ -1,4 +1,5 @@
 Rollbar.configure do |config|
+  config.enabled = ENV.has_key?('ROLLBAR_ACCESS_TOKEN')
   config.access_token = ENV["ROLLBAR_ACCESS_TOKEN"]
   config.use_sucker_punch
 end

data/template/config/puma.rb

@@ -3,8 +3,8 @@ require "./config/config"
 environment Config.rack_env
 port Config.port
 quiet
-threads Config.puma_min_threads.to_i, Config.puma_max_threads.to_i
-workers Config.puma_workers.to_i
+threads Config.puma_min_threads, Config.puma_max_threads
+workers Config.puma_workers
 
 on_worker_boot do
   # force Sequel's thread pool to be refreshed

data/template/db/schema.sql

@@ -3,6 +3,7 @@
 --
 
 SET statement_timeout = 0;
+SET lock_timeout = 0;
 SET client_encoding = 'UTF8';
 SET standard_conforming_strings = on;
 SET check_function_bodies = false;
@@ -19,7 +20,6 @@ CREATE EXTENSION IF NOT EXISTS plpgsql WITH SCHEMA pg_catalog;
 -- Name: EXTENSION plpgsql; Type: COMMENT; Schema: -; Owner: -
 --
 
-COMMENT ON EXTENSION plpgsql IS 'PL/pgSQL procedural language';
 
 
 --
@@ -33,7 +33,6 @@ CREATE EXTENSION IF NOT EXISTS "uuid-ossp" WITH SCHEMA public;
 -- Name: EXTENSION "uuid-ossp"; Type: COMMENT; Schema: -; Owner: -
 --
 
-COMMENT ON EXTENSION "uuid-ossp" IS 'generate universally unique identifiers (UUIDs)';
 
 
 --

data/template/lib/application.rb

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler.require
+
+require_relative 'initializer'

data/template/lib/endpoints/base.rb

@@ -4,6 +4,7 @@ module Endpoints
     register Pliny::Extensions::Instruments
     register Sinatra::Namespace
 
+    helpers Pliny::Helpers::Encode
     helpers Pliny::Helpers::Params
 
     set :dump_errors, false

data/template/lib/routes.rb

@@ -3,7 +3,7 @@ Routes = Rack::Builder.new do
   use Pliny::Middleware::CORS
   use Pliny::Middleware::RequestID
   use Pliny::Middleware::RequestStore, store: Pliny::RequestStore
-  use Pliny::Middleware::Timeout, timeout: Config.timeout.to_i if Config.timeout.to_i > 0
+  use Pliny::Middleware::Timeout, timeout: Config.timeout if Config.timeout > 0
   use Pliny::Middleware::Versioning,
       default: Config.versioning_default,
       app_name: Config.versioning_app_name if Config.versioning?

data/template/lib/serializers/base.rb

@@ -11,7 +11,14 @@ class Serializers
     end
 
     def serialize(object)
-      @@structures["#{self.class.name}::#{@type}"].call(object)
+      object.respond_to?(:map) ? object.map{|item| serializer.call(item)} : serializer.call(object)
     end
+
+    private
+
+    def serializer
+      @@structures["#{self.class.name}::#{@type}"]
+    end
+
   end
 end

data/test/commands/creator_test.rb

@@ -1,3 +1,4 @@
+require 'pliny/commands/creator'
 require "test_helper"
 
 describe Pliny::Commands::Creator do

data/test/commands/generator/base_test.rb

@@ -0,0 +1,103 @@
+require 'pliny/commands/generator'
+require 'pliny/commands/generator/base'
+require 'test_helper'
+
+describe Pliny::Commands::Generator::Base do
+  subject { Pliny::Commands::Generator::Base.new(model_name, {}, StringIO.new) }
+
+  describe '#singular_class_name' do
+    let(:model_name) { 'resource_histories' }
+
+    it 'builds a class name for an endpoint' do
+      assert_equal 'ResourceHistory', subject.singular_class_name
+    end
+
+    describe 'when name with hypens' do
+      let(:model_name) { 'resource-histories' }
+
+      it 'handles hyphens as underscores' do
+        assert_equal 'ResourceHistory', subject.singular_class_name
+      end
+    end
+  end
+
+  describe '#plural_class_name' do
+    let(:model_name) { 'resource_histories' }
+
+    it 'builds a class name for a model' do
+      assert_equal 'ResourceHistories', subject.plural_class_name
+    end
+
+    describe 'when name with hypens' do
+      let(:model_name) { 'resource-histories' }
+
+      it 'handles hyphens as underscores' do
+        assert_equal 'ResourceHistories', subject.plural_class_name
+      end
+    end
+  end
+
+  describe '#field_name' do
+    let(:model_name) { 'resource_histories' }
+
+    it 'uses the singular form' do
+      assert_equal 'resource_history', subject.field_name
+    end
+
+    describe 'when name with hypens' do
+      let(:model_name) { 'resource-histories' }
+
+      it 'handles hyphens as underscores' do
+        assert_equal 'resource_history', subject.field_name
+      end
+    end
+  end
+
+  describe '#pluralized_file_name' do
+    let(:model_name) { 'resource_history' }
+
+    it 'uses the plural form' do
+      assert_equal 'resource_histories', subject.pluralized_file_name
+    end
+
+    describe 'when name with hypens' do
+      let(:model_name) { 'resource-history' }
+
+      it 'handles hyphens as underscores' do
+        assert_equal 'resource_histories', subject.pluralized_file_name
+      end
+    end
+
+    describe 'when name with slashs' do
+      let(:model_name) { 'resource/history' }
+
+      it 'handles slashs as directory' do
+        assert_equal 'resource/histories', subject.pluralized_file_name
+      end
+    end
+  end
+
+  describe '#table_name' do
+    let(:model_name) { 'resource_history' }
+
+    it 'uses the plural form' do
+      assert_equal 'resource_histories', subject.table_name
+    end
+
+    describe 'when name with hypens' do
+      let(:model_name) { 'resource-history' }
+
+      it 'handles hyphens as underscores' do
+        assert_equal 'resource_histories', subject.table_name
+      end
+    end
+
+    describe 'when name with slashs' do
+      let(:model_name) { 'resource/history' }
+
+      it 'handles slashs as underscores' do
+        assert_equal 'resource_histories', subject.table_name
+      end
+    end
+  end
+end

data/test/commands/generator/endpoint_test.rb

@@ -0,0 +1,15 @@
+require 'pliny/commands/generator'
+require 'pliny/commands/generator/endpoint'
+require 'test_helper'
+
+describe Pliny::Commands::Generator::Endpoint do
+  subject { Pliny::Commands::Generator::Endpoint.new(model_name, {}, StringIO.new) }
+
+  describe '#url_path' do
+    let(:model_name) { 'resource_history' }
+
+    it 'builds a URL path' do
+      assert_equal '/resource-histories', subject.url_path
+    end
+  end
+end

data/test/commands/generator_test.rb

@@ -1,197 +1,158 @@
-require "test_helper"
+require 'pliny/commands/generator'
+require 'pliny/commands/generator/base'
+require 'test_helper'
 
 describe Pliny::Commands::Generator do
-  before do
-    @gen = Pliny::Commands::Generator.new({}, {}, StringIO.new)
-  end
+subject { Pliny::Commands::Generator.new }
 
-  describe "#field_name" do
-    it "uses the singular form" do
-      @gen.args = ["model", "resource_histories"]
-      assert_equal "resource_history", @gen.field_name
-    end
+  before do
+    FileUtils.mkdir_p('/tmp/plinytest')
+    Dir.chdir('/tmp/plinytest')
+    Timecop.freeze(@t = Time.now)
 
-    it "handles hyphens as underscores" do
-      @gen.args = ["model", "resource-histories"]
-      assert_equal "resource_history", @gen.field_name
+    any_instance_of(Pliny::Commands::Generator::Base) do |klass|
+      stub(klass).display
     end
   end
 
-  describe "#plural_class_name" do
-    it "builds a class name for a model" do
-      @gen.args = ["model", "resource_histories"]
-      assert_equal "ResourceHistories", @gen.plural_class_name
-    end
-
-    it "handles hyphens as underscores" do
-      @gen.args = ["model", "resource-histories"]
-      assert_equal "ResourceHistories", @gen.plural_class_name
-    end
+  after do
+    FileUtils.rmdir('/tmp/plinytest')
+    Timecop.return
   end
 
-  describe "#singular_class_name" do
-    it "builds a class name for an endpoint" do
-      @gen.args = ["model", "resource_histories"]
-      assert_equal "ResourceHistory", @gen.singular_class_name
+  describe '#endpoint' do
+    before do
+      subject.endpoint('artists')
     end
 
-    it "handles hyphens as underscores" do
-      @gen.args = ["model", "resource-histories"]
-      assert_equal "ResourceHistory", @gen.singular_class_name
+    it 'creates a new endpoint module' do
+      assert File.exist?('lib/endpoints/artists.rb')
     end
-  end
 
-  describe "#table_name" do
-    it "uses the plural form" do
-      @gen.args = ["model", "resource_history"]
-      assert_equal "resource_histories", @gen.table_name
+    it 'creates an endpoint test' do
+      assert File.exist?('spec/endpoints/artists_spec.rb')
     end
 
-    it "handles hyphens as underscores" do
-      @gen.args = ["model", "resource-history"]
-      assert_equal "resource_histories", @gen.table_name
+    it 'creates an endpoint acceptance test' do
+      assert File.exist?('spec/acceptance/artists_spec.rb')
     end
   end
 
-  describe "#run!" do
+  describe '#mediator' do
     before do
-      FileUtils.mkdir_p("/tmp/plinytest")
-      Dir.chdir("/tmp/plinytest")
-      Timecop.freeze(@t=Time.now)
+      subject.mediator('artists/creator')
     end
 
-    after do
-      FileUtils.rmdir("/tmp/plinytest")
-      Timecop.return
+    it 'creates a new mediator module' do
+      assert File.exist?('lib/mediators/artists/creator.rb')
     end
 
-    describe "generating endpoints" do
-      before do
-        @gen.args = ["endpoint", "artists"]
-        @gen.run!
-      end
-
-      it "creates a new endpoint module" do
-        assert File.exists?("lib/endpoints/artists.rb")
-      end
-
-      it "creates an endpoint test" do
-        assert File.exists?("spec/endpoints/artists_spec.rb")
-      end
-
-      it "creates an endpoint acceptance test" do
-        assert File.exists?("spec/acceptance/artists_spec.rb")
-      end
+    it 'creates a test' do
+      assert File.exist?('spec/mediators/artists/creator_spec.rb')
     end
+  end
 
-    describe "generating mediators" do
+  describe '#model' do
+    describe 'simple model' do
       before do
-        @gen.args = ["mediator", "artists/creator"]
-        @gen.run!
+        subject.model('artist')
       end
 
-      it "creates a new mediator module" do
-        assert File.exists?("lib/mediators/artists/creator.rb")
+      it 'creates a migration' do
+        assert File.exist?("db/migrate/#{@t.to_i}_create_artists.rb")
       end
 
-      it "creates a test" do
-        assert File.exists?("spec/mediators/artists/creator_spec.rb")
+      it 'creates the actual model' do
+        assert File.exist?('lib/models/artist.rb')
+      end
+
+      it 'creates a test' do
+        assert File.exist?('spec/models/artist_spec.rb')
       end
     end
 
-    describe "generating models" do
+    describe 'model in nested class' do
       before do
-        @gen.args = ["model", "artist"]
-        @gen.run!
+        subject.model('administration/user')
       end
 
-      it "creates a migration" do
-        assert File.exists?("db/migrate/#{@t.to_i}_create_artists.rb")
+      it 'creates a migration' do
+        assert File.exist?("db/migrate/#{@t.to_i}_create_administration_users.rb")
       end
 
-      it "creates the actual model" do
-        assert File.exists?("lib/models/artist.rb")
+      it 'creates the actual model' do
+        assert File.exist?('lib/models/administration/user.rb')
       end
 
-      it "creates a test" do
-        assert File.exists?("spec/models/artist_spec.rb")
+      it 'creates a test' do
+        assert File.exist?('spec/models/administration/user_spec.rb')
       end
     end
+  end
 
-    describe "generating scaffolds" do
-      before do
-        @gen.args = ["scaffold", "artist"]
-        @gen.run!
-      end
-
-      it "creates a new endpoint module" do
-        assert File.exists?("lib/endpoints/artists.rb")
-      end
+  describe '#scaffold' do
+    before do
+      subject.scaffold('artist')
+    end
 
-      it "creates an endpoint test" do
-        assert File.exists?("spec/endpoints/artists_spec.rb")
-      end
+    it 'creates a new endpoint module' do
+      assert File.exist?('lib/endpoints/artists.rb')
+    end
 
-      it "creates an endpoint acceptance test" do
-        assert File.exists?("spec/acceptance/artists_spec.rb")
-      end
+    it 'creates an endpoint test' do
+      assert File.exist?('spec/endpoints/artists_spec.rb')
+    end
 
-      it "creates a migration" do
-        assert File.exists?("db/migrate/#{@t.to_i}_create_artists.rb")
-      end
+    it 'creates an endpoint acceptance test' do
+      assert File.exist?('spec/acceptance/artists_spec.rb')
+    end
 
-      it "creates the actual model" do
-        assert File.exists?("lib/models/artist.rb")
-      end
+    it 'creates a migration' do
+      assert File.exist?("db/migrate/#{@t.to_i}_create_artists.rb")
+    end
 
-      it "creates a test" do
-        assert File.exists?("spec/models/artist_spec.rb")
-      end
+    it 'creates the actual model' do
+      assert File.exist?('lib/models/artist.rb')
+    end
 
-      it "creates a schema" do
-        assert File.exists?("docs/schema/schemata/artist.yaml")
-      end
+    it 'creates a test' do
+      assert File.exist?('spec/models/artist_spec.rb')
+    end
 
-      it "creates a new serializer module" do
-        assert File.exists?("lib/serializers/artist_serializer.rb")
-      end
+    it 'creates a schema' do
+      assert File.exist?('docs/schema/schemata/artist.yaml')
+    end
 
-      it "creates a test" do
-        assert File.exists?("spec/serializers/artist_serializer_spec.rb")
-      end
+    it 'creates a new serializer module' do
+      assert File.exist?('lib/serializers/artist.rb')
     end
 
-    describe "generating schemas" do
-      before do
-        @gen.args = ["schema", "artist"]
-        @gen.run!
-      end
+    it 'creates a test' do
+      assert File.exist?('spec/serializers/artist_spec.rb')
+    end
+  end
 
-      it "creates a schema" do
-        assert File.exists?("docs/schema/schemata/artist.yaml")
-      end
+  describe '#schema' do
+    before do
+      subject.schema('artist')
     end
 
-    describe "generating serializers" do
-      before do
-        @gen.args = ["serializer", "artist"]
-        @gen.run!
-      end
+    it 'creates a schema' do
+      assert File.exist?('docs/schema/schemata/artist.yaml')
+    end
+  end
 
-      it "creates a new serializer module" do
-        assert File.exists?("lib/serializers/artist_serializer.rb")
-      end
+  describe '#serializer' do
+    before do
+      subject.serializer('artist')
+    end
 
-      it "creates a test" do
-        assert File.exists?("spec/serializers/artist_serializer_spec.rb")
-      end
+    it 'creates a new serializer module' do
+      assert File.exist?('lib/serializers/artist.rb')
     end
-  end
 
-  describe "#url_path" do
-    it "builds a URL path" do
-      @gen.args = ["endpoint", "resource_history"]
-      assert_equal "/resource-histories", @gen.url_path
+    it 'creates a test' do
+      assert File.exist?('spec/serializers/artist_spec.rb')
     end
   end
 end