pliny 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53b08362a2511749050f3ca5ea9690d2adeefec8662f0a74cf391c896b119fd8
-  data.tar.gz: 23da2c0e15bdb3bf93f719e440bf0c2ac2a093fc1de3e500850c47ce5b8d6851
+  metadata.gz: 7b9a66f3564707054fd14e3115be4013984bbe64533b8fd2d01b8c2a660a2a65
+  data.tar.gz: 328be753f507e23186ee796c86dfb32e642a9144010c4f8d1c88647dc46bc2bc
 SHA512:
-  metadata.gz: fc1e1a5d4fda88d1a181e06e7aefb300d1cf6ee516ca8e6018173dfd5dcf079885ebfb8c74643db317aa889a82cd38b95ce9101a592b3126fd7039f4aa7b029c
-  data.tar.gz: 1120021ef6ade5c1470cb280504e9abad2f672610be35546d3ea2521164841e973cef2b1be2f2e1b9dd0614ac1c493e6dae818ab35cb8dff242fdd115228524c
+  metadata.gz: 5b792d492c87c023d48d65e467559d7c6dfda6b942a47d7f890196f6b791439c6e309c7cab3c920c2d8b81bca398cf77eb307dc4c189f027672a94f451cd344c
+  data.tar.gz: 762f3d62946c779204ce34712b95aced9a2246fe330baf536561ddf9a5411b6d6048a01fadff45c793b4cb33e2340400052fc21a7af7b0ca8329c74ac8867351

data/bin/pliny-generate

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../lib/pliny/commands/generator'
+require_relative "../lib/pliny/commands/generator"
 Pliny::Commands::Generator.start

data/bin/pliny-new

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "optparse"
-require_relative '../lib/pliny/commands/creator'
+require_relative "../lib/pliny/commands/creator"
 
 OptionParser.new do |options|
   opts = {}

data/bin/pliny-update

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "optparse"
-require_relative '../lib/pliny/commands/updater'
+require_relative "../lib/pliny/commands/updater"
 
 Pliny::Commands::Updater.run

data/lib/pliny/canonical_log_line_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
   # Helpers to produce a canonical log line. This mostly amounts to a set of
   # accessors that do basic type checking combined with tracking an internal

data/lib/pliny/commands/creator.rb

@@ -1,9 +1,11 @@
-require 'fileutils'
-require 'pathname'
-require 'pliny/version'
-require 'uri'
-require 'erb'
-require 'ostruct'
+# frozen_string_literal: true
+
+require "fileutils"
+require "pathname"
+require "pliny/version"
+require "uri"
+require "erb"
+require "ostruct"
 
 module Pliny::Commands
   class Creator
@@ -24,8 +26,9 @@ module Pliny::Commands
 
       FileUtils.copy_entry template_dir, app_dir
       FileUtils.rm_rf("#{app_dir}/.git")
+      FileUtils.mv("#{app_dir}/.rubocop_template.yml", "#{app_dir}/.rubocop.yml")
       parse_erb_files
-      display 'Pliny app created. To start, run:'
+      display "Pliny app created. To start, run:"
       display "cd #{app_dir} && bin/setup"
     end
 
@@ -33,15 +36,13 @@ module Pliny::Commands
 
     def parse_erb_files
       Dir.glob("#{app_dir}/{*,.*}.erb").each do |file|
-        static_file = file.gsub(/\.erb$/, '')
+        static_file = file.gsub(/\.erb$/, "")
 
         template = ERB.new(File.read(file))
         context = OpenStruct.new(app_name: name)
         content = template.result(context.instance_eval { binding })
 
-        File.open(static_file, "w") do |f|
-          f.write content
-        end
+        File.write(static_file, content)
         FileUtils.rm(file)
       end
     end
@@ -55,7 +56,7 @@ module Pliny::Commands
     end
 
     def template_dir
-      File.expand_path('../../template', File.dirname(__FILE__))
+      File.expand_path("../../template", File.dirname(__FILE__))
     end
 
     def app_dir

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

@@ -1,8 +1,10 @@
-require 'active_support/inflector'
-require 'ostruct'
-require 'erb'
-require 'fileutils'
-require 'pliny'
+# frozen_string_literal: true
+
+require "active_support/inflector"
+require "ostruct"
+require "erb"
+require "fileutils"
+require "pliny"
 
 module Pliny::Commands
   class Generator
@@ -32,7 +34,7 @@ module Pliny::Commands
       end
 
       def table_name
-        name.tableize.tr('/', '_')
+        name.tableize.tr("/", "_")
       end
 
       def display(msg)
@@ -41,7 +43,7 @@ module Pliny::Commands
 
       def render_template(template_file, vars = {})
         template_path = File.dirname(__FILE__) + "/../../templates/#{template_file}"
-        template = ERB.new(File.read(template_path), trim_mode: '>')
+        template = ERB.new(File.read(template_path), trim_mode: ">")
         context = OpenStruct.new(vars)
         template.result(context.instance_eval { binding })
       end
@@ -54,7 +56,7 @@ module Pliny::Commands
 
       def write_file(destination_path)
         FileUtils.mkdir_p(File.dirname(destination_path))
-        File.open(destination_path, 'w') do |f|
+        File.open(destination_path, "w") do |f|
           f.puts yield
         end
       end
@@ -62,7 +64,7 @@ module Pliny::Commands
       private
 
       def normalize_name(name)
-        name.underscore.tr(' ', '_')
+        name.underscore.tr(" ", "_")
       end
     end
   end

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

@@ -1,43 +1,45 @@
-require_relative 'base'
+# frozen_string_literal: true
+
+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'
+        template = options[:scaffold] ? "endpoint_scaffold.erb" : "endpoint.erb"
         write_template(template, endpoint,
-                        plural_class_name: plural_class_name,
-                        singular_class_name: singular_class_name,
-                        field_name: field_name,
-                        url_path: url_path)
+          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 "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"
-        write_template('endpoint_test.erb', test,
-                        plural_class_name: plural_class_name,
-                        singular_class_name: singular_class_name,
-                        url_path: url_path)
+        write_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'
+        template = options[:scaffold] ? "endpoint_scaffold_acceptance_test.erb" : "endpoint_acceptance_test.erb"
         write_template(template, test,
-                        plural_class_name: plural_class_name,
-                        field_name: field_name,
-                        singular_class_name: singular_class_name,
-                        url_path: url_path)
+          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.tr('_', '-')
+        "/" + name.pluralize.tr("_", "-")
       end
     end
   end

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

@@ -1,19 +1,21 @@
-require_relative 'base'
+# frozen_string_literal: true
+
+require_relative "base"
 
 module Pliny::Commands
   class Generator
     class Mediator < Base
       def create
         mediator = "./lib/mediators/#{field_name}.rb"
-        write_template('mediator.erb', mediator,
-                        singular_class_name: singular_class_name)
+        write_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"
-        write_template('mediator_test.erb', test,
-                        singular_class_name: singular_class_name)
+        write_template("mediator_test.erb", test,
+          singular_class_name: singular_class_name,)
         display "created test #{test}"
       end
     end

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

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

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

@@ -1,28 +1,30 @@
-require_relative 'base'
+# frozen_string_literal: true
+
+require_relative "base"
 
 module Pliny::Commands
   class Generator
     class Model < Base
       def create
         model = "./lib/models/#{field_name}.rb"
-        write_template('model.erb', model,
-                        singular_class_name: singular_class_name,
-                        paranoid: options[:paranoid])
+        write_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"
-        write_template('model_migration.erb', migration,
-                        table_name: table_name,
-                        paranoid: options[:paranoid])
+        write_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"
-        write_template('model_test.erb', test,
-                        singular_class_name: singular_class_name)
+        write_template("model_test.erb", test,
+          singular_class_name: singular_class_name,)
         display "created test #{test}"
       end
     end

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

@@ -1,5 +1,7 @@
-require_relative 'base'
-require 'prmd'
+# frozen_string_literal: true
+
+require_relative "base"
+require "prmd"
 
 module Pliny::Commands
   class Generator

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

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

data/lib/pliny/commands/generator.rb

@@ -1,12 +1,14 @@
-require 'pliny/version'
-require 'thor'
+# frozen_string_literal: true
+
+require "pliny/version"
+require "thor"
 
 module Pliny::Commands
   class Generator < Thor
-    desc 'endpoint NAME', 'Generates an endpoint'
+    desc "endpoint NAME", "Generates an endpoint"
     method_option :scaffold, type: :boolean, default: false, hide: true
     def endpoint(name)
-      require_relative 'generator/endpoint'
+      require_relative "generator/endpoint"
 
       ep = Endpoint.new(name, options)
       ep.create
@@ -14,27 +16,27 @@ module Pliny::Commands
       ep.create_acceptance_test
     end
 
-    desc 'mediator NAME', 'Generates a mediator'
+    desc "mediator NAME", "Generates a mediator"
     def mediator(name)
-      require_relative 'generator/mediator'
+      require_relative "generator/mediator"
 
       md = Mediator.new(name, options)
       md.create
       md.create_test
     end
 
-    desc 'migration NAME', 'Generates a migration'
+    desc "migration NAME", "Generates a migration"
     def migration(name)
-      require_relative 'generator/migration'
+      require_relative "generator/migration"
 
       mg = Migration.new(name, options)
       mg.create
     end
 
-    desc 'model NAME', 'Generates a model'
-    method_option :paranoid, type: :boolean, default: false, desc: 'adds paranoid support to model'
+    desc "model NAME", "Generates a model"
+    method_option :paranoid, type: :boolean, default: false, desc: "adds paranoid support to model"
     def model(name)
-      require_relative 'generator/model'
+      require_relative "generator/model"
 
       md = Model.new(name, options)
       md.create
@@ -42,8 +44,8 @@ module Pliny::Commands
       md.create_test
     end
 
-    desc 'scaffold NAME', 'Generates a scaffold of endpoint, model, schema and serializer'
-    method_option :paranoid, type: :boolean, default: false, desc: 'adds paranoid support to model'
+    desc "scaffold NAME", "Generates a scaffold of endpoint, model, schema and serializer"
+    method_option :paranoid, type: :boolean, default: false, desc: "adds paranoid support to model"
     method_option :scaffold, type: :boolean, default: true, hide: true
     def scaffold(name)
       endpoint(name)
@@ -52,18 +54,18 @@ module Pliny::Commands
       serializer(name)
     end
 
-    desc 'schema NAME', 'Generates a schema'
+    desc "schema NAME", "Generates a schema"
     def schema(name)
-      require_relative 'generator/schema'
+      require_relative "generator/schema"
 
       sc = Schema.new(name, options)
       sc.create
       sc.rebuild
     end
 
-    desc 'serializer NAME', 'Generates a serializer'
+    desc "serializer NAME", "Generates a serializer"
     def serializer(name)
-      require_relative 'generator/serializer'
+      require_relative "generator/serializer"
 
       se = Serializer.new(name, options)
       se.create

data/lib/pliny/commands/updater.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "pathname"
 require "pliny/version"
@@ -21,7 +23,7 @@ module Pliny::Commands
       end
 
       version_current = get_current_version
-      version_target  = Gem::Version.new(Pliny::VERSION)
+      version_target = Gem::Version.new(Pliny::VERSION)
 
       if version_current == version_target
         display "Version #{version_current} is current, nothing to update."
@@ -50,14 +52,14 @@ module Pliny::Commands
 
     def get_current_version
       File.read("./Gemfile.lock").split("\n").each do |line|
-        next unless pliny_version = line.match(/pliny \(([\d+\.]+)\)/)
+        next unless (pliny_version = line.match(/pliny \(([\d+.]+)\)/))
         return Gem::Version.new(pliny_version[1])
       end
     end
 
     def save_patch(curr, target)
       # take a diff of changes that happened to the template app in Pliny
-      diff = `cd #{repo_dir} && git diff v#{curr}..v#{target} lib/template/`
+      diff = `cd #{repo_dir} && GIT_CONFIG_GLOBAL=/dev/null git diff v#{curr}..v#{target} lib/template/`
 
       # remove /lib/template from the path of files in the patch so that we can
       # apply these to the current folder

data/lib/pliny/config_helpers.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Pliny
   module CastingConfigHelpers
-    def mandatory(name, method=nil)
+    def mandatory(name, method = nil)
       value = cast(ENV.fetch(name.to_s.upcase), method)
       create(name, value)
     end
 
-    def optional(name, method=nil)
+    def optional(name, method = nil)
       value = cast(ENV[name.to_s.upcase], method)
       create(name, value)
     end
 
-    def override(name, default, method=nil)
+    def override(name, default, method = nil)
       value = cast(ENV.fetch(name.to_s.upcase, default), method)
       create(name, value)
     end
@@ -24,7 +26,7 @@ module Pliny
     end
 
     def bool
-      ->(v) { v.to_s=='true'}
+      ->(v) { v.to_s == "true" }
     end
 
     def string
@@ -42,31 +44,19 @@ module Pliny
     # optional :notype, array
     # => ['a', 'b']
     def array(method = nil)
-      -> (v) do
-        if v
-          v.split(",").map{|a| cast(a, method) }
-        end
+      ->(v) do
+        v&.split(",")&.map { |a| cast(a, method) }
       end
     end
 
     def rack_env
-      if env == "development" || env == "test"
+      if app_env == "development" || app_env == "test"
         "development"
       else
         "deployment"
       end
     end
 
-    # DEPRECATED: pliny_env is deprecated in favour of app_env.
-    #             See more at https://github.com/interagent/pliny/issues/277
-    #
-    # This method is kept temporary in case it is used somewhere in the app.
-    def pliny_env
-      warn "Config.pliny_env is deprecated and will be removed, " \
-           "use Config.app_env instead."
-      env
-    end
-
     private
 
     def cast(value, method)
@@ -76,24 +66,10 @@ module Pliny
     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)
+      if value.is_a?(TrueClass) || value.is_a?(FalseClass) || value.is_a?(NilClass)
         instance_eval "def #{name}?; !!@#{name} end", __FILE__, __LINE__
       end
     end
-
-    # This method helps with transition from PLINY_ENV to APP_ENV.
-    def env
-      legacy_env || app_env
-    end
-
-    # PLINY_ENV is deprecated, but it might be still used by someone.
-    def legacy_env
-      if ENV.key?('PLINY_ENV')
-        warn "PLINY_ENV is deprecated in favour of APP_ENV, " \
-             "update .env file or application configuration."
-        ENV['PLINY_ENV']
-      end
-    end
   end
 
   # DEPRECATED: ConfigHelpers was a slightly more primitive version
@@ -130,7 +106,6 @@ module Pliny
       end
     end
   end
-
 end
 
 # Supress the "use RbConfig instead" warning