model_view 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d2669fe111931e97ab7797c72e6e2c378d9725e
-  data.tar.gz: 5651183f0f88dc42ed84bcb83eebf16bfd0c589d
+  metadata.gz: 71429c06ee7aa9db651f524b4c91ad9c339ae689
+  data.tar.gz: f44a76b5e2fe0847f6ea86da4729278fa9296b14
 SHA512:
-  metadata.gz: 32d9f88924bd18f90d0b883996bf9d15ff7c16d551097f33f46a8bccd8c60395fec14850e44337d98787baed113730e1904012573cca071baef10ed9a8b11ba5
-  data.tar.gz: 56489585b9e4fbf2194dd006dc22fe47b41b62eb849ba328f9602a08ac760874b22e678ade00719b548e873e32ba1d8df2c078fa343aaa8ed43e0c551447d9fe
+  metadata.gz: '01014719b0d56562ff129f4dd5f1a8eb2f54210b46bd365b89abf4e8ff0360035edbcb3a00fc6515aa222b061ee1f57259c1fce34c8cbd5d215669bf98f718ed'
+  data.tar.gz: 76f2f35fc561f8afaa2195f79f1257df20c1c68d4f2d7d9d861b0a8cc72e39985bfae54d4ac77cdcb34883818e720ddd9d7584973e1aba488c94b2d75b028c78

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+# 0.1.2
+* Cleaned up ModelView.as_hash arguments
+* Update readme
+
+
 # 0.1.1
 * Fix default scope value
 

data/README.md

@@ -1,2 +1,103 @@
 # model_view
-Composable serialisation for models
+## Composable serialisation for models
+
+ModelView let's you define views for your models in one place.
+
+### Why ModelView?
+
+At OfferZen, most of our rails models can be presented in al least two ways. For example, an Interview Request
+is presented differently to a candidate than to a company. But, there is also a lot of fields that get presented
+the same to both candidates and companies. We found ourselves duplicating a lot of our serialisation code in our
+controllers and the code started to get out of hand.
+
+ModelView works with Rails, but Rails is definitely not a requirement
+
+### How to use ModelView
+
+1) Include the yem in your gemfile
+```ruby
+gem "model_view", '~> 0.1'
+```
+2) Create a view class (we put these in `app/model_views`)
+
+```ruby
+class PersonView
+  extend ModelView
+
+end
+```
+3) Define fields
+
+```ruby
+field :name
+
+field(:first_name) { |person| person.name.split(' ').first }
+
+field :is_current_user, context[:current_user] do |person|
+  person.name.split(' ').first
+end
+```
+4) Let ModelView serialise an instance
+
+```ruby
+person = Person.find(1)
+PersonView.as_hash(person, context: {current_user: current_user})
+=> {
+  name: "Billy Bob",
+  first_name: "Billy",
+  is_current_user: false
+}
+```
+
+#### Scopes
+
+Scopes allows you to create serialisation snippets that can be composed
+
+Example:
+```ruby
+field :id
+
+scope :demographics do
+  field :name
+  field(:first_name) { |person| person.name.split(' ').first }
+  field(:last_name) { |person| person.name.split(' ').first }
+end
+
+scope :status do
+  field :is_current_user, context[:current_user] do |person|
+    person.name.split(' ').first
+  end
+end
+
+scope :all do
+  extend_scope :demographics
+  extend_scope :status
+end
+```
+
+```ruby
+person = Person.find(1)
+
+PersonView.as_hash(person, context: {current_user: current_user})
+=> {
+  id: 1
+}
+
+
+PersonView.as_hash(person, context: {current_user: current_user, scope: :demographics})
+=> {
+  id:   1,
+  name: "Billy Bob",
+  first_name: "Billy",
+  last_name: "Bob",
+}
+
+PersonView.as_hash(person, context: {current_user: current_user, scope: :all})
+=> {
+  id:   1,
+  name: "Billy Bob",
+  first_name: "Billy",
+  last_name: "Bob",
+  is_current_user: true
+}
+```

data/lib/model_view.rb

@@ -36,8 +36,10 @@ module ModelView
     @scopes
   end
 
-  def as_hash(object, scope=nil, context={})
-    ModelView::Resolver.resolve(object, @scopes, scope || ROOT, context)
+  def as_hash(object, opts={} )
+    scope = opts[:scope] || ROOT
+    context = opts[:context] || {}
+    ModelView::Resolver.resolve(object, @scopes, scope , context)
   end
 
   private

data/lib/model_view/version.rb

@@ -1,3 +1,3 @@
 module ModelView
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_view
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Martin Pretorius