ki 0.4.11 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 027faaedcab27f0fd3f3d65e878da0dfd98e74da
-  data.tar.gz: bc9e0f3ec9dd2c17fa4b238b829bd50afcdce5f3
+  metadata.gz: 35f976a6f383442703ea03ac1404d94c82700ded
+  data.tar.gz: b3ac5a018c3922d4487578f8146ec789f4fc7195
 SHA512:
-  metadata.gz: aa073bd56faec752bea84241acd3602b85c010628d10f393c006d96337ed9952d064af70991b69b6a40108df3794433ed9ecc8ac6f469eb7c6682b0b5e6d538c
-  data.tar.gz: 97eebe5a6b2e5b0e03d029e44dbe8bcdeacb9f16a7d721dd2644ff74be97fa67ab81dac38f19c3e9f057d442e6d57ca531281c136294d7744c394896fc243aed
+  metadata.gz: b0964d164dec6c2f62ee0f630c8c5c94e2df7a0755e68d68050ac2b48fc671ff15e2cb278a64fb24e24495354ec6fb632003da97f0f7c527684ef8f1825cd483
+  data.tar.gz: 667ecc89434a469d3b89709a720b4505ae38a61558fd8fe59525ae277a5ff1a45e2cd9f0eff48e2c138d7aa4f1cc6f646a0bd3f0ee711b8336f8d18466a710bc

data/.gitignore

@@ -12,3 +12,4 @@ spec/examples/*/log
 spec/examples/*/Gemfile.lock
 
 /doc/*
+coverage/

data/.rubocop.yml

@@ -22,3 +22,12 @@ Metrics/AbcSize:
 
 Lint/UnusedMethodArgument:
   Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false

data/.ruby-gemset

@@ -1 +1 @@
-ki
+ki2

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.4.3

data/.travis.yml

@@ -1,6 +1,14 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.1.0
+  - 2.1
+  - 2.4.3
 services:
   - mongodb
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    ki (0.4.11)
+    ki (0.4.12)
       bson_ext
-      bundler (~> 1.5)
+      bundler
       coffee-script
       faye-websocket
       haml
-      mongo (= 1.9.2)
+      mongo
       rack
       rack-cors
       rack-parser
@@ -17,116 +17,126 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
-    bson (1.9.2)
-    bson_ext (1.9.2)
-      bson (~> 1.9.2)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    celluloid-io (0.15.0)
-      celluloid (>= 0.15.0)
-      nio4r (>= 0.5.0)
-    codeclimate-test-reporter (0.4.7)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
+    ast (2.4.0)
+    bson (4.3.0)
+    bson_ext (1.5.1)
+    coderay (1.1.2)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.10.0)
-    diff-lcs (1.2.5)
+    coffee-script-source (1.12.2)
+    diff-lcs (1.3)
     docile (1.1.5)
-    eventmachine (1.2.0.1)
-    execjs (2.6.0)
-    faye-websocket (0.10.3)
+    eventmachine (1.2.5)
+    execjs (2.7.0)
+    faye-websocket (0.10.7)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
-    ffi (1.9.3)
-    formatador (0.2.4)
-    guard (2.5.1)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    guard (2.14.2)
       formatador (>= 0.2.4)
-      listen (~> 2.6)
-      lumberjack (~> 1.0)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
       pry (>= 0.9.12)
+      shellany (~> 0.0)
       thor (>= 0.18.1)
-    guard-rspec (4.2.8)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
-      rspec (>= 2.14, < 4.0)
-    guard-rubocop (1.2.0)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
       guard (~> 2.0)
       rubocop (~> 0.20)
-    haml (4.0.7)
+    haml (5.0.4)
+      temple (>= 0.8.0)
       tilt
-    listen (2.7.1)
-      celluloid (>= 0.15.2)
-      celluloid-io (>= 0.15.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.5)
-    method_source (0.8.2)
-    mongo (1.9.2)
-      bson (~> 1.9.2)
-    multi_json (1.11.0)
-    nio4r (1.0.0)
-    parser (2.2.2.1)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.0)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rack (1.5.2)
-    rack-cors (0.4.0)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    mongo (2.5.1)
+      bson (>= 4.3.0, < 5.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.0.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-cors (1.0.2)
     rack-parser (0.7.0)
       rack
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rainbow (2.0.0)
-    rake (10.1.1)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.3)
-      ffi (>= 0.5.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rubocop (0.30.1)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.2.1, < 3.0)
+    rack-test (0.8.3)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.5)
-    sass (3.4.22)
-    simplecov (0.9.2)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    sass (3.5.5)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    shellany (0.0.1)
+    simplecov (0.13.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    slop (3.5.0)
-    thor (0.18.1)
-    tilt (2.0.2)
-    timers (1.1.0)
-    websocket-driver (0.6.3)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    temple (0.8.0)
+    thor (0.20.0)
+    tilt (2.0.8)
+    unicode-display_width (1.3.0)
+    websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.2)
+    websocket-extensions (0.1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  codeclimate-test-reporter
   guard-rspec
   guard-rubocop
   ki!
   rack-test
   rake
   rspec
+  simplecov
 
 BUNDLED WITH
-   1.10.6
+   1.16.1

data/Guardfile

@@ -1,15 +1,21 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-group :red_green_refactor, halt_on_fail: true do
-  guard :rspec do
-    watch(%r{^spec/.+_spec\.rb$})
-    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-    watch('spec/spec_helper.rb')  { 'spec' }
-  end
-
-  guard :rubocop, cli: ['--config=.rubocop.yml', '--display-cop-names'] do
-    watch(/.+\.rb$/)
-    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-  end
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(/%r{.+\.rb$}/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
 end

data/MIDDLEWARE.md

@@ -46,7 +46,7 @@ development:
     name: base_development
     host: 127.0.0.1
     port: 27017
-  add_middleware: ['Realtime', 'DocGenerator', 'AdminInterfaceGenerator']
+  add_middleware: ['Realtime', 'InstaDoc', 'AdminInterfaceGenerator']
   rm_middleware: ['SassCompiler']
 
 test:
@@ -57,7 +57,7 @@ test:
 
 production:
   middleware: ['ApiHandler', 'PublicFileServer']
-  add_middleware: ['Realtime', 'DocGenerator', 'AdminInterfaceGenerator']
+  add_middleware: ['Realtime', 'InstaDoc', 'AdminInterfaceGenerator']
   database:
     name: np
     host: 127.0.0.1

data/README.md

@@ -35,6 +35,7 @@ and provides a fullblown REST api on top.
   - [Before/after callbacks](#beforeafter-callbacks)
     - [Accessing the json object within the callback](#accessing-the-json-object-within-the-callback)
   - [Exceptions](#exceptions)
+  - [Logging](#logging)
   - [Magic](#magic)
 - [Deploy](#deploy)
   - [Heroku deployment](#heroku-deployment)
@@ -382,6 +383,19 @@ class Todo < Ki::Model
 end
 ```
 
+### Logging
+
+By default, logs are written in the `logs` folder and are rotated weekly if and
+only if the `logs` folder exists.
+
+To add something to the log you can:
+
+```
+Ki::KiLogger.instance.logger.info 'for your info'
+Ki::KiLogger.instance.logger.warn 'warning'
+Ki::KiLogger.instance.logger.error 'ops'
+```
+
 ### Magic
 
 #### redirect_to param
@@ -422,9 +436,23 @@ Yes.
 
 ## Documentation
 
-Ki offers instant documentation. Add the middleware 'DocGenerator' and access
+Ki offers instant documentation. Add the middleware 'InstaDoc' and access
 */instadoc*.
 
+```
+class Todo < Ki::Model
+  _body 'is required because reasons'
+  requires :body
+
+  _desc 'This is a before all description'
+  def before_all
+  end
+
+  _desc 'This is a general description. Needs to be above a method called "doc"'
+  def doc; end
+end
+```
+
 ## Administration Interface
 
 Ki offers an instant administration interface. Add the middleware 'AdminIntefaceGenerator'

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rdoc/task'
@@ -5,7 +7,7 @@ require 'rdoc/task'
 RDoc::Task.new do |rdoc|
   rdoc.main = 'README.md'
   rdoc.rdoc_files
-    .include('README.md', 'lib/**/*.rb')
+      .include('README.md', 'lib/**/*.rb')
   rdoc.rdoc_dir = 'doc'
 end
 

data/bin/ki

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 

data/ki.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ki/version'
@@ -16,24 +17,24 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = %w(lib examples)
+  spec.require_paths = %w[lib examples]
 
-  spec.add_runtime_dependency 'bundler', '~> 1.5'
+  spec.add_runtime_dependency 'bson_ext'
+  spec.add_runtime_dependency 'bundler'
+  spec.add_runtime_dependency 'coffee-script'
+  spec.add_runtime_dependency 'faye-websocket'
+  spec.add_runtime_dependency 'haml'
+  spec.add_runtime_dependency 'mongo'
   spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'rack-cors'
   spec.add_runtime_dependency 'rack-parser'
-  spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'haml'
   spec.add_runtime_dependency 'sass'
-  spec.add_runtime_dependency 'coffee-script'
-  spec.add_runtime_dependency 'mongo', '1.9.2'
-  spec.add_runtime_dependency 'bson_ext'
-  spec.add_runtime_dependency 'rack-cors'
-  spec.add_runtime_dependency 'faye-websocket'
+  spec.add_runtime_dependency 'thor'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-rubocop'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
 end