pliny 0.2.1 → 0.3.0

data/lib/pliny/commands/generator/base.rb

@@ -0,0 +1,59 @@
+require 'active_support/inflector'
+require 'ostruct'
+require 'erb'
+require 'fileutils'
+require 'pliny'
+
+module Pliny::Commands
+  class Generator
+    class Base
+      attr_reader :name, :stream, :options
+
+      def initialize(name, options = {}, stream = $stdout)
+        @name = name
+        @options = options
+        @stream = stream
+      end
+
+      def singular_class_name
+        name.gsub(/-/, '_').singularize.camelize
+      end
+
+      def plural_class_name
+        name.gsub(/-/, '_').pluralize.camelize
+      end
+
+      def field_name
+        name.tableize.singularize
+      end
+
+      def pluralized_file_name
+        name.tableize
+      end
+
+      def table_name
+        name.tableize.gsub('/', '_')
+      end
+
+      def display(msg)
+        stream.puts msg
+      end
+
+      def render_template(template_file, destination_path, vars = {})
+        template_path = File.dirname(__FILE__) + "/../../templates/#{template_file}"
+        template = ERB.new(File.read(template_path), 0, '>')
+        context = OpenStruct.new(vars)
+        write_file(destination_path) do
+          template.result(context.instance_eval { binding })
+        end
+      end
+
+      def write_file(destination_path)
+        FileUtils.mkdir_p(File.dirname(destination_path))
+        File.open(destination_path, 'w') do |f|
+          f.puts yield
+        end
+      end
+    end
+  end
+end

data/lib/pliny/commands/generator/endpoint.rb

@@ -0,0 +1,44 @@
+require_relative 'base'
+
+module Pliny::Commands
+  class Generator
+    class Endpoint < Base
+      def create
+        endpoint = "./lib/endpoints/#{pluralized_file_name}.rb"
+        template = options[:scaffold] ? 'endpoint_scaffold.erb' : 'endpoint.erb'
+        render_template(template, endpoint,
+                        plural_class_name: plural_class_name,
+                        singular_class_name: singular_class_name,
+                        field_name: field_name,
+                        url_path: url_path)
+        display "created endpoint file #{endpoint}"
+        display 'add the following to lib/routes.rb:'
+        display "  mount Endpoints::#{plural_class_name}"
+      end
+
+      def create_test
+        test = "./spec/endpoints/#{pluralized_file_name}_spec.rb"
+        render_template('endpoint_test.erb', test,
+                        plural_class_name: plural_class_name,
+                        singular_class_name: singular_class_name,
+                        url_path: url_path)
+        display "created test #{test}"
+      end
+
+      def create_acceptance_test
+        test = "./spec/acceptance/#{pluralized_file_name}_spec.rb"
+        template = options[:scaffold] ? 'endpoint_scaffold_acceptance_test.erb' : 'endpoint_acceptance_test.erb'
+        render_template(template, test,
+                        plural_class_name: plural_class_name,
+                        field_name: field_name,
+                        singular_class_name: singular_class_name,
+                        url_path: url_path)
+        display "created test #{test}"
+      end
+
+      def url_path
+        '/' + name.pluralize.gsub(/_/, '-')
+      end
+    end
+  end
+end

data/lib/pliny/commands/generator/mediator.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module Pliny::Commands
+  class Generator
+    class Mediator < Base
+      def create
+        mediator = "./lib/mediators/#{field_name}.rb"
+        render_template('mediator.erb', mediator,
+                        singular_class_name: singular_class_name)
+        display "created mediator file #{mediator}"
+      end
+
+      def create_test
+        test = "./spec/mediators/#{field_name}_spec.rb"
+        render_template('mediator_test.erb', test,
+                        singular_class_name: singular_class_name)
+        display "created test #{test}"
+      end
+    end
+  end
+end

data/lib/pliny/commands/generator/migration.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+
+module Pliny::Commands
+  class Generator
+    class Migration < Base
+      def create
+        migration = "./db/migrate/#{Time.now.to_i}_#{name}.rb"
+        render_template('migration.erb', migration)
+        display "created migration #{migration}"
+      end
+    end
+  end
+end

data/lib/pliny/commands/generator/model.rb

@@ -0,0 +1,30 @@
+require_relative 'base'
+
+module Pliny::Commands
+  class Generator
+    class Model < Base
+      def create
+        model = "./lib/models/#{field_name}.rb"
+        render_template('model.erb', model,
+                        singular_class_name: singular_class_name,
+                        paranoid: options[:paranoid])
+        display "created model file #{model}"
+      end
+
+      def create_migration
+        migration = "./db/migrate/#{Time.now.to_i}_create_#{table_name}.rb"
+        render_template('model_migration.erb', migration,
+                        table_name: table_name,
+                        paranoid: options[:paranoid])
+        display "created migration #{migration}"
+      end
+
+      def create_test
+        test = "./spec/models/#{field_name}_spec.rb"
+        render_template('model_test.erb', test,
+                        singular_class_name: singular_class_name)
+        display "created test #{test}"
+      end
+    end
+  end
+end

data/lib/pliny/commands/generator/schema.rb

@@ -0,0 +1,24 @@
+require_relative 'base'
+require 'prmd'
+
+module Pliny::Commands
+  class Generator
+    class Schema < Base
+      def create
+        schema = "./docs/schema/schemata/#{field_name}.yaml"
+        write_file(schema) do
+          Prmd.init(name.singularize, yaml: true)
+        end
+        display "created schema file #{schema}"
+      end
+
+      def rebuild
+        schemata = './docs/schema.json'
+        write_file(schemata) do
+          Prmd.combine('./docs/schema/schemata', meta: './docs/schema/meta.json')
+        end
+        display "rebuilt #{schemata}"
+      end
+    end
+  end
+end

data/lib/pliny/commands/generator/serializer.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module Pliny::Commands
+  class Generator
+    class Serializer < Base
+      def create
+        serializer = "./lib/serializers/#{name}.rb"
+        render_template('serializer.erb', serializer,
+                        singular_class_name: singular_class_name)
+        display "created serializer file #{serializer}"
+      end
+
+      def create_test
+        test = "./spec/serializers/#{name}_spec.rb"
+        render_template('serializer_test.erb', test,
+                        singular_class_name: singular_class_name)
+        display "created test #{test}"
+      end
+    end
+  end
+end

data/lib/pliny/config_helpers.rb

@@ -1,4 +1,55 @@
 module Pliny
+  module CastingConfigHelpers
+    def mandatory(name, method=nil)
+      value = cast(ENV.fetch(name.to_s.upcase), method)
+      create(name, value)
+    end
+
+    def optional(name, method=nil)
+      value = cast(ENV[name.to_s.upcase], method)
+      create(name, value)
+    end
+
+    def override(name, default, method=nil)
+      value = cast(ENV.fetch(name.to_s.upcase, default), method)
+      create(name, value)
+    end
+
+    def int
+      ->(v) { v.to_i }
+    end
+
+    def float
+      ->(v) { v.to_f }
+    end
+
+    def bool
+      ->(v) { v.to_s=='true'}
+    end
+
+    def string
+      nil
+    end
+
+    def symbol
+      ->(v) { v.to_sym }
+    end
+
+    private
+
+    def cast(value, method)
+      method ? method.call(value) : value
+    end
+
+    def create(name, value)
+      instance_variable_set(:"@#{name}", value)
+      instance_eval "def #{name}; @#{name} end", __FILE__, __LINE__
+      if value.kind_of?(TrueClass) || value.kind_of?(FalseClass) || value.kind_of?(NilClass)
+        instance_eval "def #{name}?; !!@#{name} end", __FILE__, __LINE__
+      end
+    end
+  end
+
   module ConfigHelpers
     def optional(*attrs)
       attrs.each do |attr|
@@ -28,6 +79,7 @@ module Pliny
       end
     end
   end
+
 end
 
 # Supress the "use RbConfig instead" warning.

data/lib/pliny/helpers/encode.rb

@@ -0,0 +1,7 @@
+module Pliny::Helpers
+  module Encode
+    def encode(object)
+      MultiJson.encode(object, pretty: params[:pretty] == 'true' || Config.pretty_json)
+    end
+  end
+end

data/lib/pliny/log.rb

@@ -1,10 +1,19 @@
 module Pliny
   module Log
     def log(data, &block)
-      data = log_context.merge(data)
+      data = log_context.merge(local_context.merge(data))
       log_to_stream(stdout || $stdout, data, &block)
     end
 
+    def context(data, &block)
+      old = local_context
+      self.local_context = old.merge(data)
+      res = block.call
+    ensure
+      local_context = old
+      res
+    end
+
     def stdout=(stream)
       @stdout = stream
     end
@@ -15,6 +24,14 @@ module Pliny
 
     private
 
+    def local_context
+      RequestStore.store[:local_context] ||= {}
+    end
+
+    def local_context=(h)
+      RequestStore.store[:local_context] = h
+    end
+
     def log_context
       RequestStore.store[:log_context] || {}
     end

data/lib/pliny/middleware/versioning.rb

@@ -22,7 +22,7 @@ module Pliny::Middleware
       version = nil
       media_types.map! do |media_type|
         if accept_headers.include?(media_type.format)
-          if !media_type.params["version"]
+          unless media_type.params['version']
             error = { id: :bad_version, message: <<-eos }
 Please specify a version along with the MIME type. For example, `Accept: application/vnd.#{@app_name}+json; version=1`.
             eos
@@ -30,7 +30,7 @@ Please specify a version along with the MIME type. For example, `Accept: applica
               [MultiJson.encode(error)]]
           end
 
-          if !version
+          unless version
             version = media_type.params["version"]
           end
 
@@ -41,7 +41,7 @@ Please specify a version along with the MIME type. For example, `Accept: applica
         end
         media_type.to_s
       end
-      env["HTTP_ACCEPT"] = media_types.map(&:to_s).join(", ")
+      env['HTTP_ACCEPT'] = media_types.join(', ')
 
       version ||= @default
       set_api_version(env, version)

data/lib/pliny/tasks/db.rake

@@ -78,19 +78,33 @@ namespace :db do
   namespace :schema do
     desc "Load the database schema"
     task :load do
-      schema = File.read("./db/schema.sql")
-      database_urls.each do |database_url|
-        db = Sequel.connect(database_url)
-        db.run(schema)
-        puts "Loaded `#{name_from_uri(database_url)}`"
+      if File.exists?("./db/schema.sql")
+        schema = File.read("./db/schema.sql")
+        database_urls.each do |database_url|
+          db = Sequel.connect(database_url)
+          db.run(schema)
+          puts "Loaded `#{name_from_uri(database_url)}`"
+        end
+      else
+        puts "Skipped schema load, schema.sql not present"
       end
     end
 
     desc "Dump the database schema"
     task :dump do
+      file = File.join("db", "schema.sql")
       database_url = database_urls.first
-      `pg_dump -i -s -x -O -f ./db/schema.sql #{database_url}`
-      puts "Dumped `#{name_from_uri(database_url)}` to db/schema.sql"
+      `pg_dump -i -s -x -O -f #{file} #{database_url}`
+
+      schema = File.read(file)
+      # filter all COMMENT ON EXTENSION, only owners and the db
+      # superuser can execute these, making it impossible to just
+      # replay such statements in certain production databases
+      schema.gsub!(/^COMMENT ON EXTENSION.*\n/, "")
+
+      File.open(file, "w") { |f| f.puts schema }
+
+      puts "Dumped `#{name_from_uri(database_url)}` to #{file}"
     end
 
     desc "Merges migrations into schema and removes them"

data/lib/pliny/tasks/schema.rake

@@ -1,5 +1,5 @@
 desc "Rebuild schema.json"
 task :schema do
-  require 'pliny'
-  Pliny::Commands::Generator.new.rebuild_schema
+  require 'pliny/commands/generator/schema'
+  Pliny::Commands::Generator::Schema.new(nil).rebuild
 end

data/lib/pliny/templates/endpoint.erb

@@ -6,24 +6,24 @@ module Endpoints
       end
 
       get do
-        "[]"
+        encode []
       end
 
       post do
         status 201
-        "{}"
+        encode {}
       end
 
       get "/:id" do
-        "{}"
+        encode {}
       end
 
       patch "/:id" do |id|
-        "{}"
+        encode {}
       end
 
       delete "/:id" do |id|
-        "{}"
+        encode {}
       end
     end
   end

data/lib/pliny/templates/endpoint_acceptance_test.erb

@@ -20,7 +20,7 @@ describe Endpoints::<%= plural_class_name %> do
     end
   end
 
-  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({})