napa 0.3.0 → 0.4.0

data/lib/napa/generators/migration_generator.rb

@@ -5,10 +5,15 @@ module Napa
   module Generators
     class MigrationGenerator < Thor::Group
       include Thor::Actions
+      # largely ported over, with a few differences, from
+      # https://github.com/rails/rails/blob/76883f92374c6395f13c16628e1d87d40b6d2399/activerecord/lib/rails/generators/active_record/migration/migration_generator.rb
       argument :migration_name
+      argument :attributes, type: :array, default: []
+
+      attr_reader :migration_action, :join_tables, :table_name
 
       def version
-        Time.now.utc.to_s.gsub(':','').gsub('-','').gsub('UTC','').gsub(' ','')
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
       end
 
       def migration_filename
@@ -19,12 +24,204 @@ module Napa
         './db/migrate'
       end
 
+      def parse_attributes!
+        self.attributes = (attributes || []).map do |attr|
+          GeneratedAttribute.parse(attr)
+        end
+      end
+
+      def set_local_assigns!
+        @migration_template = "migration"
+        filename = migration_name.underscore
+        case filename
+        when /^(add|remove)_.*_(?:to|from)_(.*)/
+          @migration_action = $1
+          @table_name       = $2.pluralize
+        when /join_table/
+          if attributes.length == 2
+            @migration_action = 'join'
+            @join_tables      = attributes.map(&:plural_name)
+
+            set_index_names
+          end
+        when /^create_(.+)/
+          @table_name = $1.pluralize
+          @migration_template = "create_table_migration"
+        end
+      end
+
       def migration
-        self.class.source_root "#{File.dirname(__FILE__)}/templates/migration"
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/#{@migration_template}"
         say 'Generating migration...'
         directory '.', output_directory
         say 'Done!', :green
       end
+
+      private
+        def attributes_with_index
+          attributes.select { |a| !a.reference? && a.has_index? }
+        end
+
+        def set_index_names
+          attributes.each_with_index do |attr, i|
+            attr.index_name = [attr, attributes[i - 1]].map{ |a| index_name_for(a) }
+          end
+        end
+
+        def index_name_for(attribute)
+          if attribute.foreign_key?
+            attribute.name
+          else
+            attribute.name.singularize.foreign_key
+          end.to_sym
+        end
+    end
+
+    # directly ported from
+    # https://github.com/rails/rails/blob/76883f92374c6395f13c16628e1d87d40b6d2399/railties/lib/rails/generators/generated_attribute.rb
+    class GeneratedAttribute # :nodoc:
+      INDEX_OPTIONS = %w(index uniq)
+      UNIQ_INDEX_OPTIONS = %w(uniq)
+
+      attr_accessor :name, :type
+      attr_reader   :attr_options
+      attr_writer   :index_name
+
+      class << self
+        def parse(column_definition)
+          name, type, has_index = column_definition.split(':')
+
+          # if user provided "name:index" instead of "name:string:index"
+          # type should be set blank so GeneratedAttribute's constructor
+          # could set it to :string
+          has_index, type = type, nil if INDEX_OPTIONS.include?(type)
+
+          type, attr_options = *parse_type_and_options(type)
+          type = type.to_sym if type
+
+          if type && reference?(type)
+            references_index = UNIQ_INDEX_OPTIONS.include?(has_index) ? { unique: true } : true
+            attr_options[:index] = references_index
+          end
+
+          new(name, type, has_index, attr_options)
+        end
+
+        def reference?(type)
+          [:references, :belongs_to].include? type
+        end
+
+        private
+
+        # parse possible attribute options like :limit for string/text/binary/integer, :precision/:scale for decimals or :polymorphic for references/belongs_to
+        # when declaring options curly brackets should be used
+        def parse_type_and_options(type)
+          case type
+          when /(string|text|binary|integer)\{(\d+)\}/
+            return $1, limit: $2.to_i
+          when /decimal\{(\d+)[,.-](\d+)\}/
+            return :decimal, precision: $1.to_i, scale: $2.to_i
+          when /(references|belongs_to)\{polymorphic\}/
+            return $1, polymorphic: true
+          else
+            return type, {}
+          end
+        end
+      end
+
+      def initialize(name, type=nil, index_type=false, attr_options={})
+        @name           = name
+        @type           = type || :string
+        @has_index      = INDEX_OPTIONS.include?(index_type)
+        @has_uniq_index = UNIQ_INDEX_OPTIONS.include?(index_type)
+        @attr_options   = attr_options
+      end
+
+      def field_type
+        @field_type ||= case type
+          when :integer              then :number_field
+          when :float, :decimal      then :text_field
+          when :time                 then :time_select
+          when :datetime, :timestamp then :datetime_select
+          when :date                 then :date_select
+          when :text                 then :text_area
+          when :boolean              then :check_box
+          else
+            :text_field
+        end
+      end
+
+      def default
+        @default ||= case type
+          when :integer                     then 1
+          when :float                       then 1.5
+          when :decimal                     then "9.99"
+          when :datetime, :timestamp, :time then Time.now.to_s(:db)
+          when :date                        then Date.today.to_s(:db)
+          when :string                      then name == "type" ? "" : "MyString"
+          when :text                        then "MyText"
+          when :boolean                     then false
+          when :references, :belongs_to     then nil
+          else
+            ""
+        end
+      end
+
+      def plural_name
+        name.sub(/_id$/, '').pluralize
+      end
+
+      def singular_name
+        name.sub(/_id$/, '').singularize
+      end
+
+      def human_name
+        name.humanize
+      end
+
+      def index_name
+        @index_name ||= if polymorphic?
+          %w(id type).map { |t| "#{name}_#{t}" }
+        else
+          column_name
+        end
+      end
+
+      def column_name
+        @column_name ||= reference? ? "#{name}_id" : name
+      end
+
+      def foreign_key?
+        !!(name =~ /_id$/)
+      end
+
+      def reference?
+        self.class.reference?(type)
+      end
+
+      def polymorphic?
+        self.attr_options.has_key?(:polymorphic)
+      end
+
+      def has_index?
+        @has_index
+      end
+
+      def has_uniq_index?
+        @has_uniq_index
+      end
+
+      def password_digest?
+        name == 'password' && type == :digest 
+      end
+
+      def inject_options
+        "".tap { |s| @attr_options.each { |k,v| s << ", #{k}: #{v.inspect}" } }
+      end
+
+      def inject_index_options
+        has_uniq_index? ? ", unique: true" : ""
+      end
     end
   end
 end

data/lib/napa/generators/readme_generator.rb

@@ -0,0 +1,47 @@
+require 'thor'
+require 'active_support/all'
+require 'napa/setup'
+require 'napa/identity'
+require 'dotenv'
+
+module Napa
+  module Generators
+    class ReadmeGenerator < Thor::Group
+      include Thor::Actions
+
+      def load_environment
+        Napa.load_environment
+      end
+
+      def service_name
+        Napa::Identity.name
+      end
+
+      def routes
+        routes = ""
+
+        if defined? ApplicationApi
+          ApplicationApi.routes.each do |api|
+            method      = api.route_method.ljust(10)
+            path        = api.route_path.ljust(40)
+            description = api.route_description
+            routes     += "     #{method} #{path} # #{description}"
+          end
+        end
+
+        routes
+      end
+
+      def output_directory
+        '.'
+      end
+
+      def readme
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/readme"
+        say 'Generating readme...'
+        directory '.', output_directory
+        say 'Done!', :green
+      end
+    end
+  end
+end

data/lib/napa/generators/templates/create_table_migration/%migration_filename%.rb.tt

@@ -0,0 +1,19 @@
+class <%= migration_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<% else -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/napa/generators/templates/migration/%migration_filename%.rb.tt

@@ -1,4 +1,39 @@
 class <%= migration_name.camelize %> < ActiveRecord::Migration
+<%- if migration_action == 'add' -%>
   def change
+<% attributes.each do |attribute| -%>
+  <%- if attribute.reference? -%>
+    add_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %>
+  <%- else -%>
+    add_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
+    <%- if attribute.has_index? -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>
   end
-end
+<%- elsif migration_action == 'join' -%>
+  def change
+    create_join_table :<%= join_tables.first %>, :<%= join_tables.second %> do |t|
+    <%- attributes.each do |attribute| -%>
+      <%= '# ' unless attribute.has_index? -%>t.index <%= attribute.index_name %><%= attribute.inject_index_options %>
+    <%- end -%>
+    end
+  end
+<%- else -%>
+  def change
+<% attributes.each do |attribute| -%>
+<%- if migration_action -%>
+  <%- if attribute.reference? -%>
+    remove_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %>
+  <%- else -%>
+    <%- if attribute.has_index? -%>
+    remove_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+    <%- end -%>
+    remove_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
+  <%- end -%>
+<%- end -%>
+<%- end -%>
+  end
+<%- end -%>
+end

data/lib/napa/generators/templates/readme/README.md.tt

@@ -0,0 +1,55 @@
+# <%= service_name %>
+
+:bow: Please put your auspicious [Travis status button](http://docs.travis-ci.com/user/status-images/) here :bow:
+
+1. [Overview](#overview)
+2. [How Does It Work](#how-does-it-work)
+3. [Endpoints](#endpoints)
+4. [Development](#development)
+5. [Extra Links](#extra-links)
+
+### Overview
+
+:bow: Tell us about your wonderful service :bow:
+
+In this section, please answer the questions, "What is this service?" or "What does this service do?"
+
+### How Does It Work
+
+Ohhh tell us, how does it function? :bow: :bow:
+
+Tell us about the __mechanics__ or __logic__ driving the service. Diagrams and pictures are :angel:
+
+### Endpoints
+
+How must we interact with your great service? :bow:
+
+Try typing `rake routes` into your console, and then paste that here.
+
+If those endpoints need to be explained in more detail, please bless us with your wisdom.
+
+### Development
+
+```
+bundle install
+
+rake db:reset
+
+rspec spec
+
+rackup
+```
+
+So wonderful, so informative! :bow:
+
+What else do we need to know so that a new developer can start contributing __within 30 minutes__?
+
+### Extra Links
+
+What a perfectly constructed service! We're so honored :bow:
+
+If your service makes heavy use of other gems or API's, imbue us with that knowledge in the form of
+
+- [Link to documentation]()
+- [etc.]()
+- [For information on how to create links in Markdown, please click here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links)

data/lib/napa/generators/templates/readme/spec/docs/readme_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'README' do
+  it 'has been filled out' do
+    pending 'Please fill out the sections that have a :bow:'
+  end
+end

data/lib/napa/generators/templates/scaffold/.env.test.tt

@@ -1,3 +1,6 @@
+# Uncomment when using Napa::Middleware::Authentication
+# HEADER_PASSWORD=''
+
 SERVICE_NAME=<%= app_name %>
 RACK_ENV=test
 

data/lib/napa/generators/templates/scaffold/.env.tt

@@ -1,3 +1,6 @@
+# Uncomment when using Napa::Middleware::Authentication
+# HEADER_PASSWORD=''
+
 SERVICE_NAME=<%= app_name %>
 
 DATABASE_USER='<%= @database_user %>'

data/lib/napa/generators/templates/scaffold/.gitignore.tt

@@ -4,6 +4,7 @@
 .rspec
 .env
 !.env.test
+!log/.keep
 log/*
 tmp/*
 coverage

data/lib/napa/generators/templates/scaffold/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
+require 'napa/setup'
 require 'dotenv'
-Dotenv.load(ENV['RACK_ENV'] == 'test' ? '.env.test' : '.env')
+Napa.load_environment
 
 require './app'
 require 'json'

data/lib/napa/generators/templates/scaffold/app.rb

@@ -6,7 +6,7 @@ Bundler.require(:default, Napa.env.to_sym)
 require 'napa'
 
 # load environment
-Dotenv.load(Napa.env.test? ? '.env.test' : '.env')
+Napa.load_environment
 
 # autoload initalizers
 Dir['./config/initializers/**/*.rb'].map { |file| require file }

data/lib/napa/generators/templates/scaffold/config.ru.tt

@@ -10,11 +10,12 @@ require './app'
 #   end
 # end
 #
-# use Honeybadger::Rack
+# use Honeybadger::Rack::ErrorNotifier
 # use Napa::Middleware::Logger
 
 use Napa::Middleware::AppMonitor
-use Napa::Middleware::Authentication
+# Uncomment to require header passwords for all requestss
+# use Napa::Middleware::Authentication
 use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
 run ApplicationApi

data/lib/napa/generators.rb

@@ -1,3 +1,4 @@
 require 'napa/generators/scaffold_generator'
 require 'napa/generators/api_generator'
 require 'napa/generators/migration_generator'
+require 'napa/generators/readme_generator'

data/lib/napa/middleware/logger.rb

@@ -7,7 +7,7 @@ module Napa
 
       def call(env)
         # log the request
-        Napa::Logger.logger.debug format_request(env)
+        Napa::Logger.logger.info format_request(env)
 
         # process the request
         status, headers, body = @app.call(env)

data/lib/napa/middleware/request_stats.rb

@@ -31,9 +31,7 @@ module Napa
         path = normalize_path(request.path_info)
 
         # Emit stats to StatsD
-        Napa::Stats.emitter.increment('request_count')
         Napa::Stats.emitter.timing('response_time', response_time)
-        Napa::Stats.emitter.increment("path.#{Napa::Stats.path_to_key(request.request_method, path)}.request_count")
         Napa::Stats.emitter.timing("path.#{Napa::Stats.path_to_key(request.request_method, path)}.response_time", response_time)
 
         # Return the results

data/lib/napa/output_formatters/entity.rb

@@ -1,5 +1,9 @@
 module Napa
   class Entity < Grape::Entity
+    def self.inherited(subclass)
+      ActiveSupport::Deprecation.warn 'Use of Napa::Entity is discouraged, please transition your code to Roar representers - https://github.com/bellycard/napa/blob/master/docs/grape_entity_to_roar.md', caller
+    end
+
     format_with :to_s do |val|
       val.to_s
     end

data/lib/napa/rspec_extensions/response_helpers.rb

@@ -12,6 +12,35 @@ module Napa
       def response_body
         last_response.body
       end
+      
+      def result_count
+        parsed_response.data.count
+      end
+
+      def first_result
+        parsed_response.data.first
+      end
+
+      def result_with_id(id)
+        parsed_response.data.select { |r| r.id == id }.first
+      end
+
+      def expect_count_of(count)
+        expect(result_count).to eq(count)
+      end
+
+      def expect_only(object)
+        expect_count_of 1
+        expect(first_result.id).to eq(object.id)
+      end
+
+      def expect_to_have(object)
+        expect(!!result_with_id(object.id)).to be_truthy
+      end
+
+      def expect_to_not_have(object)
+        expect(!!result_with_id(object.id)).to be_falsy
+      end
     end
   end
 end

data/lib/napa/setup.rb

@@ -5,6 +5,18 @@ require 'active_support'
 
 module Napa
   class << self
+    def load_environment
+      Dotenv.load(Napa.env.test? ? '.env.test' : '.env')
+    end
+
+    def skip_initialization
+      @_skip_initialization || false
+    end
+
+    def skip_initialization=(value)
+      @_skip_initialization = value if [TrueClass, FalseClass].include?(value.class)
+    end
+
     def env
       @_env ||= ActiveSupport::StringInquirer.new(ENV['RACK_ENV'] || 'development')
     end
@@ -12,5 +24,13 @@ module Napa
     def env=(environment)
       @_env = ActiveSupport::StringInquirer.new(environment)
     end
+
+    def cache
+      @_cache ||= ActiveSupport::Cache.lookup_store(:memory_store)
+    end
+
+    def cache=(store_option)
+      @_cache = ActiveSupport::Cache.lookup_store(store_option)
+    end
   end
 end

data/lib/napa/stats_d_timer.rb

@@ -3,7 +3,7 @@ module Napa
     def report_time(timer_name)
       start_time = Time.now
       yield
-      response_time = Time.now - start_time
+      response_time = (Time.now - start_time) * 1000 # statsd reports timers in milliseconds
       Napa::Stats.emitter.timing(timer_name, response_time)
     end
 

data/lib/napa/version.rb

@@ -1,5 +1,5 @@
 module Napa
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 
   class Version
     class << self

data/lib/napa.rb

@@ -16,8 +16,10 @@ require 'napa/logger/parseable'
 require 'napa/identity'
 require 'napa/json_error'
 require 'napa/stats'
+require 'napa/stats_d_timer'
 require 'napa/active_record_extensions/filter_by_hash'
 require 'napa/active_record_extensions/stats'
+require 'napa/active_record_extensions/seeder'
 require 'napa/grape_extensions/error_formatter'
 require 'napa/grape_extensions/grape_helpers'
 require 'napa/output_formatters/entity'
@@ -31,10 +33,26 @@ require 'napa/middleware/request_stats'
 require 'napa/middleware/database_stats'
 require 'napa/authentication'
 
+require 'napa/deprecations'
+require 'napa/deploy'
+require 'napa/gem_dependency'
+
 # load rake tasks if Rake installed
 if defined?(Rake)
-  load 'tasks/git.rake'
   load 'tasks/deploy.rake'
   load 'tasks/routes.rake'
   load 'tasks/db.rake'
 end
+
+module Napa
+  class << self
+    def initialize
+      unless Napa.skip_initialization
+        Napa::Logger.logger.info Napa::GemDependency.log_all if Napa.env.production?
+        Napa::Deprecations.initialization_checks
+      end
+    end
+  end
+end
+
+Napa.initialize

data/lib/tasks/db.rake

@@ -72,5 +72,12 @@ unless defined?(Rails)
         load(file)
       end
     end
+
+    desc 'Load the seed data from db/seeds.rb'
+    task :seed => :environment do
+      ActiveRecord::Tasks::DatabaseTasks.seed_loader = Napa::ActiveRecordSeeder.new './db/seeds.rb'
+      ActiveRecord::Tasks::DatabaseTasks.load_seed
+    end
+
   end
 end

data/lib/tasks/deploy.rake

@@ -1,13 +1,11 @@
 namespace :deploy do
   desc "Deploy to production"
   task :production do
-    Rake::Task["git:verify"].invoke
-    Rake::Task["git:set_tag"].invoke
+    puts "\033[31mrake deploy:production is deprecated, please use 'napa deploy production'\033[0m"
   end
 
   desc "Deploy to staging"
   task :staging do
-    Rake::Task["git:verify"].invoke
-    Rake::Task["git:set_tag"].invoke("staging")
+    puts "\033[31mrake deploy:staging is deprecated, please use 'napa deploy staging'\033[0m"
   end
 end

data/lib/tasks/routes.rake

@@ -2,9 +2,10 @@ unless defined?(Rails)
   desc "display all routes for Grape"
   task :routes do
     ApplicationApi.routes.each do |api|
-      method  = api.route_method.ljust(10)
-      path    = api.route_path
-      puts    "     #{method} #{path}"
+      method      = api.route_method.ljust(10)
+      path        = api.route_path.ljust(40)
+      description = api.route_description
+      puts        "     #{method} #{path} # #{description}"
     end
   end
 end