client-data-adapter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6216761a500dd0fcc1078802338d3a8d540892fe8da2229c1b3fe5d77593ed62
-  data.tar.gz: 6176e29e6d7584c501708b09b72c9621af509e93fe41b60952ff6ee65b4a17fd
+  metadata.gz: 5929dffa53704cde41c2ab3f5472f688678fa8de7a0383e638a3b52781176fa9
+  data.tar.gz: d1be7b858a73bdb311833b68cb9895d63855dbfc46ba0f6040ad5cd8ee018389
 SHA512:
-  metadata.gz: 4383e461e62527c305161c1b02c9d2d6b2cbc991ebe4d6cc1504d8b349955b42db9e9bb4877802738969b24996088bf9d7c97222088bba968df43203d7860d84
-  data.tar.gz: 431b1dccf85d3da56bd3cdd35583455c51b6a7261dd64924b274fd786789696ba76765b63026d88dcd7a7d54b317e3fa401035a63370fa6002b65469c489e230
+  metadata.gz: 04bef8fde33f7b9107defcf0e13bfabaf25d35ee8dd7b7f106f13e70285cc21cb628ebb07cae95383e21cc0f4f3cb4b2794a9643065c0f20df27b3f4297304a7
+  data.tar.gz: '08624aa572e2e24c816eb57140c1357de7ef3a0201bbf8a8d0d506019abced4d65e6c1b6cd8805264ac874076c32c4b82179caaa49d9dd277bfd078304c7256f'

data/README.md

@@ -47,7 +47,8 @@ include ClientDataAdapter
 
 define_adapter do
 
-  # define your adapter here...
+  # define your adapter here.
+  # ... 
 
 end
 
@@ -55,7 +56,7 @@ end
 
 ### `adapter`
 
-`adapter` method define the main adapter, and common structure should be a `Hash`. 
+`adapter` method define the main adapter, should return a `Hash`. 
 
 ```ruby
 # ...
@@ -84,8 +85,8 @@ In elsewhere
 
 ### `with`
 
-And you are probably need some complex calculation or related some other class,
-they maybe need some cost and don't need to load everywhere.
+And you probably need some complex calculation or related some other class,
+they maybe need some cost and is unnecessary to load everywhere.
 
 So we need use them *on-demand*.
 
@@ -165,8 +166,6 @@ end
 or this
 
 ```ruby
-# ...
-
 with :foo do |*args|
   args.join(',')
 end
@@ -231,7 +230,7 @@ And you can read the adapter internal method via it.
 @book.adapter_wrapper.my_method # => works
 ```
 
-hmm... but i am not very recommend you to use it by this way, 
+hmm... but i'm not very recommend you to use it by this way, 
 if you need some method works alone, 
 maybe you should define it in the original class.
 
@@ -291,12 +290,13 @@ Then
 ```
 
 Of course you can pass some arguments, and if you have several links,
-they can also used in nested.
+can also used in nested.
 
 ```ruby
 # ...
  
-@book.adapter(book_shelf: [library: :some_method])
+@book.adapter(book_shelf: [:foo, library: :bar])
+# => { ..., book_shelf: { ..., foo: ..., library: { ..., bar: ... } } }
 ```
 
 And can define many links once.
@@ -336,23 +336,6 @@ end
 
 ```
 
-```ruby
-# category.rb
-
-define_adapter do
-  
-  adapter do
-    {
-      id: id,
-      desc: desc,
-    }
-  end
-    
-end
-```
-
-Then
-
 ```ruby
 @book.adapter(:categories)
 # => { id: 1, title: 'My Book', categories: @book.categories.map(&:adapter) }

data/client-data-adapter.gemspec

@@ -1,10 +1,12 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require_relative './lib/client-data-adapter/version'
+
 Gem::Specification.new do |s|
 
   s.name = 'client-data-adapter'
-  s.version = '0.1.0'
+  s.version = ClientDataAdapter::VERSION
   s.summary = 'client data adapter'
   s.description = 'For unify data formats to transfer to clients.'
   s.authors = ['shadow']

data/lib/client-data-adapter.rb

@@ -1,6 +1,11 @@
 require_relative 'client-data-adapter/class_methods'
 require_relative 'client-data-adapter/instance_methods'
 
+# For unify data formats to transfer to clients.
+#
+# Homepage https://github.com/jinghua000/client-data-adapter
+#
+# @author shadow <https://github.com/jinghua000>
 module ClientDataAdapter
 
   def self.included(base)

data/spec/adapter_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../demo/book'
 
-RSpec.describe Book do
+RSpec.describe ClientDataAdapter do
 
   before(:each) do
     @book = Book.demo

data/spec/adapter_wrapper_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../demo/book'
 
-RSpec.describe Book do
+RSpec.describe ClientDataAdapter do
 
   before(:each) do
     @book = Book.demo

data/spec/link_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../demo/book'
 
-RSpec.describe Book do
+RSpec.describe ClientDataAdapter do
 
   before(:each) do
     @book = Book.demo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client-data-adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - shadow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies: []
 description: For unify data formats to transfer to clients.
 email: 
@@ -37,7 +37,6 @@ files:
 - lib/client-data-adapter/wrapper.rb
 - spec/adapter_spec.rb
 - spec/adapter_wrapper_spec.rb
-- spec/demo_spec.rb
 - spec/link_spec.rb
 - spec/spec_helper.rb
 - update.sh

data/spec/demo_spec.rb

@@ -1,5 +0,0 @@
-require_relative '../demo/book'
-
-RSpec.describe Book do
-
-end