repres-dosser 1.8.3 → 1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5906319adab603857976c30257c1c3cba8a1bf1d
-  data.tar.gz: 8ad5cc9e2b653899bedb7d0d5cd02e6f19ce20fe
+  metadata.gz: 6225ace816757924b0affa10b971289536da5842
+  data.tar.gz: 936f844a42e192bec54e3b55bf1d7864052ca664
 SHA512:
-  metadata.gz: e986af84bd67b7789fe904090568b98f34e2a2725062903058217a701a656aef879d5cf96a3ca9423c289c1d8df9d76391eca07d261f547980b4633322b7ba6c
-  data.tar.gz: 5796b592fee696186c56a4876fdb0f3716de9b80a262576ff32bc549d0d44a2e9b50b95417220fed8bb43cbec021a8a83f128970472ba5336a4b08eef127ec28
+  metadata.gz: 0fa35156c795e372b4d71a3858413f7d954c7631264bf686e0c895ace7b83c2dd7cc28ee1bf4481e82cc69d98d953f039abbb60895b6027aa446393a9c267bd2
+  data.tar.gz: 529ff9d1c7ed8c6cfa40d2e9f1a5e56ad4b474ca605448f88f9f988eb5b3e5b7b73c38f959405d2d61b38b2cdbc6ff80f725ad207f5c7cdcf7fd8f7da5c6f45e

data/README.md

@@ -1,6 +1,8 @@
 # Repres Dosser 领域特定语意表现引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/repres-dosser/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/repres-dosser.svg)](https://badge.fury.io/rb/repres-dosser)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/repres-dosser.svg)](https://gemnasium.com/github.com/topbitdu/repres-dosser)
 
@@ -167,3 +169,18 @@ before insert the swagger_engine & the latest repres-dosser gem into the Gemfile
 config/initializers/swagger_engine.rb
 lib/swagger/administration_api_v2.json
 ```
+
+
+
+## RSpec examples
+
+```ruby
+# spec/models/unidom_spec.rb
+require 'repres/dosser/models_rspec'
+
+# spec/types/unidom_spec.rb
+require 'repres/dosser/types_rspec'
+
+# spec/validators/unidom_spec.rb
+require 'repres/dosser/validators_rspec'
+```

data/app/controllers/repres/dosser/application_controller.rb

@@ -1,3 +1,6 @@
+##
+# Application controller 是模块内所有控制器的基类。
+
 class Repres::Dosser::ApplicationController < ActionController::Base
   protect_from_forgery with: :exception
 end

data/app/controllers/repres/dosser/concerns/resource_presentation.rb

@@ -1,3 +1,10 @@
+##
+# Resource Presentation 是 DOSSER 风格的资源表现逻辑的关注点。
+# HTTP 状态码可参考以下链接：
+# https://httpstatuses.com/
+# http://www.restapitutorial.com/httpstatuscodes.html
+# http://guides.rubyonrails.org/layouts_and_rendering.html#the-status-option
+
 module Repres::Dosser::Concerns::ResourcePresentation
 
   extend ActiveSupport::Concern
@@ -14,11 +21,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
 
     attr_writer :criteria
 
-    # https://httpstatuses.com/
-    # http://www.restapitutorial.com/httpstatuscodes.html
-    # http://guides.rubyonrails.org/layouts_and_rendering.html#the-status-option
-
-    # 200
+    ##
+    # 返回 HTTP 状态码 200 ok 。
     def render_ok(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -35,7 +39,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 201
+    ##
+    # 返回 HTTP 状态码 201 。
     def render_created(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -52,7 +57,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 202
+    ##
+    # 返回 HTTP 状态码 202 。
     def render_accepted(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -69,7 +75,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 204
+    ##
+    # 返回 HTTP 状态码 204 。
     def render_no_content(
       success:    true,
       code:       self.class::CODE_SUCCESS,
@@ -86,7 +93,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 400
+    ##
+    # 返回 HTTP 状态码 400 。
     def render_bad_request(
       success:    false,
       code:       self.class::CODE_FAILURE_WRONG_PARAMETER,
@@ -103,7 +111,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 401
+    ##
+    # 返回 HTTP 状态码 401 。
     def render_unauthorized(
       success:    false,
       code:       self.class::CODE_FAILURE,
@@ -120,7 +129,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 403 forbidden
+    ##
+    # 返回 HTTP 状态码 403 forbidden 。
     def render_forbidden(
       success:    false,
       code:       self.class::CODE_FAILURE_FORBIDDEN,
@@ -137,7 +147,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 404
+    ##
+    # 返回 HTTP 状态码 404 。
     def render_not_found(
       success:    false,
       code:       self.class::CODE_FAILURE_NOT_FOUND,
@@ -169,7 +180,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
     end
 =end
 
-    # 409
+    ##
+    # 返回 HTTP 状态码 409 。
     def render_conflict(
       success:    false,
       code:       self.class::CODE_FAILURE_WRONG_STATE,
@@ -186,7 +198,8 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
-    # 500
+    ##
+    # 返回 HTTP 状态码 500 。
     def render_internal_server_error(
       success:    false,
       code:       self.class::CODE_FAILURE,

data/app/jobs/repres/dosser/application_job.rb

@@ -1,2 +1,5 @@
+##
+# Application job 是模块内所有异步任务的基类。
+
 class Repres::Dosser::ApplicationJob < ActiveJob::Base
 end

data/app/mailers/repres/dosser/application_mailer.rb

@@ -1,3 +1,6 @@
+##
+# Application mailer 是模块内所有电子邮件发送类的基类。
+
 class Repres::Dosser::ApplicationMailer < ActionMailer::Base
   default from: 'from@example.com'
   layout 'mailer'

data/app/models/repres/dosser/application_record.rb

@@ -1,3 +1,6 @@
+##
+# Application record 是模块内所有模型的抽象基类。
+
 class Repres::Dosser::ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

data/app/views/layouts/repres/dosser/application.html.erb

@@ -2,7 +2,7 @@
 <html>
 <head>
   <title>Repres Dosser</title>
-  <%= stylesheet_link_tag "repres/dosser/application", media: "all" %>
+  <%= stylesheet_link_tag 'repres/dosser/application', media: "all" %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/lib/repres/dosser/version.rb

@@ -1,5 +1,5 @@
 module Repres
   module Dosser
-    VERSION = '1.8.3'.freeze
+    VERSION = '1.9'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repres-dosser
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: '1.9'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2017-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,6 +60,9 @@ files:
 - lib/generators/repres/dosser/swagger/templates/lib/swagger/api.json.erb
 - lib/repres/dosser.rb
 - lib/repres/dosser/engine.rb
+- lib/repres/dosser/models_rspec.rb
+- lib/repres/dosser/types_rspec.rb
+- lib/repres/dosser/validators_rspec.rb
 - lib/repres/dosser/version.rb
 - lib/tasks/dosser_tasks.rake
 homepage: https://github.com/topbitdu/repres-dosser