ki 0.4.11 → 0.4.12

data/lib/ki.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ruby stdlib
 require 'yaml'
 require 'uri'
@@ -12,10 +14,14 @@ require 'coffee-script'
 require 'mongo'
 require 'faye/websocket'
 require 'eventmachine'
+require 'logger'
 
 # code
+require 'ki/utils/annotations'
+require 'ki/utils/descendants'
 require 'ki/utils/api_error'
 require 'ki/utils/extra_ruby'
+require 'ki/utils/logger'
 require 'ki/utils/indifferent_hash'
 
 require 'ki/modules/query_interface'
@@ -36,11 +42,12 @@ require 'ki/middleware/public_file_server'
 require 'ki/middleware/sass_compiler'
 require 'ki/middleware/haml_compiler'
 require 'ki/middleware/coffee_compiler'
-require 'ki/middleware/doc_generator'
+require 'ki/middleware/insta_doc'
 require 'ki/middleware/admin_interface_generator'
 require 'ki/middleware/realtime'
 
 require 'ki/ki_config'
+require 'ki/ki_logger'
 require 'ki/helpers'
 require 'ki/orm'
 require 'ki/model'

data/lib/ki/base_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   class BaseRequest < Rack::Request
     include Middleware::Helpers::FormatOf
@@ -20,13 +22,13 @@ module Ki
 
     def headers
       Hash[*env.select { |k, _v| k.start_with? 'HTTP_' }
-        .collect { |k, v| [k.sub(/^HTTP_/, ''), v] }
-        .sort
-        .flatten]
+               .collect { |k, v| [k.sub(/^HTTP_/, ''), v] }
+               .sort
+               .flatten]
     end
 
     def to_ki_model_class
-      path.to_s.gsub('/', '').gsub(format_of(path), '').gsub('.', '').to_class
+      path.to_s.delete('/').gsub(format_of(path), '').delete('.').to_class
     end
 
     def to_action
@@ -42,7 +44,7 @@ module Ki
       when 'SEARCH'
         :find
       else
-        fail 'unkown action'
+        raise 'unkown action'
       end
     end
   end

data/lib/ki/channel_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   class ChannelManager
     def self.connect

data/lib/ki/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Helpers
     include Middleware::Helpers::View
@@ -16,11 +18,8 @@ module Ki
 
     def partial(s)
       path = view_path(s)
-      if File.file?(path)
-        haml(File.read(path))
-      else
-        fail PartialNotFoundError, path
-      end
+      raise PartialNotFoundError, path unless File.file?(path)
+      haml(File.read(path))
     end
   end
 end

data/lib/ki/ki.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   class Ki
     PUBLIC_PATH = 'public'
@@ -8,6 +10,14 @@ module Ki
 
       @app = Rack::Builder.new do
         use Middleware::InitMiddleware
+
+        if Dir.exist?('logs')
+          logfile = ::File.join('logs', 'requests.log')
+          logger = ::Logger.new(logfile, 'weekly')
+          KiLogger.instance.init(logger)
+          use Rack::CommonLogger, logger
+        end
+
         use Rack::Parser, content_types: {
           'application/json' => proc { |body| ::MultiJson.decode body }
         }
@@ -15,8 +25,7 @@ module Ki
           use Rack::Cors do
             allow do
               origins '*'
-              resource '*', headers: :any, methods: [:get, :search, :put, :post, :delete]
-              # resource '*', headers: :any, methods: :any # TODO: find out why :any doesn't work
+              resource '*', headers: :any, methods: %i[get search put post delete]
             end
           end
         end

data/lib/ki/ki_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   class KiApp
     include Middleware::Helpers::HamlCompiler

data/lib/ki/ki_cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 require 'ki/utils/extra_irb'
@@ -7,15 +9,20 @@ module Ki
     class KiGenerator < Thor::Group #:nodoc:
       include Thor::Actions
 
+      def self.say(s)
+        puts s
+      end
+
       def self.source_root
         File.join(File.dirname(__FILE__), '..', '..')
       end
 
       def self.requires_ki_directory
-        unless File.exist? 'config.ru'
+        unless File.exist?('config.ru')
           say 'Working directory should be a ki app.'
           exit 3
         end
+        say 'Found config.ru'
       end
     end
 
@@ -23,7 +30,7 @@ module Ki
       argument :app_name
 
       def prepare_dir
-        unless app_name =~ /^[a-zA-Z0-9-]*$/
+        unless app_name.match?(/^[a-zA-Z0-9-]*$/)
           say 'App name must contain only alphanumeric characters and -'
           exit 1
         end

data/lib/ki/ki_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module Ki
@@ -5,6 +7,7 @@ module Ki
     include Singleton
 
     attr_reader :config, :environment
+    attr_accessor :logger
 
     def read(environment)
       @environment = environment
@@ -21,8 +24,8 @@ module Ki
     end
 
     def middleware
-      used_middleware = %w(ApiHandler CoffeeCompiler SassCompiler HamlCompiler
-                           PublicFileServer)
+      used_middleware = %w[ApiHandler CoffeeCompiler SassCompiler HamlCompiler
+                           PublicFileServer]
       used_middleware = @config['middleware'] if @config['middleware']
 
       used_middleware = add_rm_middleware used_middleware, 'add_middleware', 'push'

data/lib/ki/ki_logger.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Ki
+  class KiLogger
+    include Singleton
+
+    attr_accessor :logger
+
+    def init logger
+      @logger = logger
+    end
+  end
+end

data/lib/ki/middleware/admin_interface_generator.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
-    class AdminInterfaceGenerator < DocGenerator
+    class AdminInterfaceGenerator < InstaDoc
       def custom_view_path
         File.join(File.dirname(__FILE__), '..', 'views', 'instadmin.haml')
       end

data/lib/ki/middleware/api_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware #:nodoc:
     # Handles all API calls
@@ -24,7 +26,7 @@ module Ki
         klass = req.to_ki_model_class
 
         unless Model.descendants.include?(klass)
-          fail InvalidUrlError.new("invalid url '#{req.path}'", 404)
+          raise InvalidUrlError.new("invalid url '#{req.path}'", 404)
         end
 
         model = klass.new(req)

data/lib/ki/middleware/base_middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware #:nodoc:
     module BaseMiddleware

data/lib/ki/middleware/coffee_compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware #:nodoc:
     class CoffeeCompiler

data/lib/ki/middleware/haml_compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     class HamlCompiler

data/lib/ki/middleware/helpers/format_of_helper.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     module Helpers
       module FormatOf
         def format_of(uri)
           uri = uri.path if uri.class == BaseRequest
-          File.extname(URI.parse(uri).path).gsub('.', '')
+          File.extname(URI.parse(uri).path).delete('.')
         rescue URI::InvalidURIError
           ''
         end

data/lib/ki/middleware/helpers/haml_compiler_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     module Helpers
@@ -5,11 +7,11 @@ module Ki
         def render_haml_file(file_path, layout = true)
           file_contents = File.read(file_path)
 
-          if layout && view_exists?('layout')
-            layout_contents = File.read(view_path('layout'))
-          else
-            layout_contents = '= yield'
-          end
+          layout_contents = if layout && view_exists?('layout')
+                              File.read(view_path('layout'))
+                            else
+                              '= yield'
+                            end
 
           html = render_haml(layout_contents).render do
             render_haml(file_contents).render

data/lib/ki/middleware/helpers/public_file_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     module Helpers

data/lib/ki/middleware/helpers/redirect_to_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     module Helpers

data/lib/ki/middleware/helpers/view_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     module Helpers

data/lib/ki/middleware/init_middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
     class InitMiddleware

data/lib/ki/middleware/{doc_generator.rb → insta_doc.rb}

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware
-    class DocGenerator < HamlCompiler
+    class InstaDoc < HamlCompiler
       include BaseMiddleware
 
       def call(env)
         req = BaseRequest.new env
         if custom_check(req)
-          if view_exists?(req)
-            html = render_haml_file view_path(req)
-          else
-            html = render_haml_file custom_view_path
-          end
+          html = if view_exists?(req)
+                   render_haml_file view_path(req)
+                 else
+                   render_haml_file custom_view_path
+                 end
           Rack::Response.new(html).finish
         else
           @app.call env

data/lib/ki/middleware/public_file_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware #:nodoc:
     class PublicFileServer

data/lib/ki/middleware/realtime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware #:nodoc:
     class Realtime
@@ -39,7 +41,7 @@ module Ki
 
         timer = EventMachine::PeriodicTimer.new(1) do
           msgs = ::Ki::ChannelManager.tick(socket_id: socket['id'])
-          ws_send(ws, { messages: msgs }) if msgs.count > 0
+          ws_send(ws, { messages: msgs }) if msgs.count.positive?
         end
 
         ws.on :close do # |event|

data/lib/ki/middleware/sass_compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ki
   module Middleware #:nodoc:
     class SassCompiler

data/lib/ki/model.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
+
 module Ki
   class Model
+    extend Descendants
     extend QueryInterface
     extend Restrictions
     include Callbacks
     include ModelHelper
     include Middleware::Helpers::RedirectTo
 
+    annotate!
+
     attr_accessor :action, :result, :params, :status, :req
 
     def initialize(req)
@@ -14,7 +19,7 @@ module Ki
       @params = req.params
       @status = 200
 
-      fail ForbiddenAction if forbidden_actions.include? @action
+      raise ForbiddenAction if forbidden_actions.include? @action
 
       ccall
     end
@@ -44,7 +49,7 @@ module Ki
     def check_for_required_attributes
       required_attributes.each do |ra|
         unless @params.keys.include?(ra.to_s)
-          fail RequiredAttributeMissing, "#{ra} missing"
+          raise RequiredAttributeMissing, "#{ra} missing"
         end
       end
     end
@@ -52,7 +57,7 @@ module Ki
     def check_for_unique_attributes
       unique_attributes.each do |ua|
         u = self.class.find({ ua.to_s => @params[ua.to_s] })
-        fail AttributeNotUnique, "#{ua} not unique" unless u.empty?
+        raise AttributeNotUnique, "#{ua} not unique" unless u.empty?
       end
     end
 
@@ -63,9 +68,5 @@ module Ki
       send "after_#{@action}".to_sym
       after_all
     end
-
-    def self.descendants
-      ObjectSpace.each_object(Class).select { |klass| klass < self }
-    end
   end
 end

data/lib/ki/modules/callbacks.rb

@@ -1,35 +1,27 @@
+# frozen_string_literal: true
+
 module Ki
   class Model
     module Callbacks
-      def before_all
-      end
+      def before_all; end
 
-      def before_find
-      end
+      def before_find; end
 
-      def after_find
-      end
+      def after_find; end
 
-      def before_create
-      end
+      def before_create; end
 
-      def after_create
-      end
+      def after_create; end
 
-      def before_update
-      end
+      def before_update; end
 
-      def after_update
-      end
+      def after_update; end
 
-      def before_delete
-      end
+      def before_delete; end
 
-      def after_delete
-      end
+      def after_delete; end
 
-      def after_all
-      end
+      def after_all; end
     end
   end
 end