model_view 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef140793172f7e2692c3fb46cf86a5d9ee94acb
-  data.tar.gz: fbd1d07a10c07fd055db7e126d05112902b80d85
+  metadata.gz: 5bbb9e6927b9d2a9a2350d4b2b9fa3bb914a125d
+  data.tar.gz: 58d8e67a612acda3b04469af9573ef2f71bfc2bb
 SHA512:
-  metadata.gz: d1eba489732401a4448576c68a076ab27a1af43b623108a65fec0056c2c4c6689823595027cce93f55e652427a5eb64db583d1c77a06d3362aa96dfa418a65d9
-  data.tar.gz: bb8f406b8de03109e1e93061776097b69bac01f6451cf6bd977979e22044420b0c6923ceb58ff4ee1d5d853018511e1ab26eb6b3531d0b14e59c2ae911139ac9
+  metadata.gz: 68014a9a7f17ad08e169fed2cb92d2582e886821e51bb7690412cec03263a97204bd1c80f127855f907ef52050abbbf42c5edf0b52e57fe64f99d3ab81233250
+  data.tar.gz: 4283cf11f8300868265c6763fef87a6626d0cd61926bfa822fc7b23099848ba4e12d68f60fd8f59d174e05657cec2b2497657090d714aa75373429ccdb13da22

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 0.2.0
+* ModelView can add a convenience method to the model class
+
+
 # 0.1.3
 * Readme fixes
 

data/README.md

@@ -49,6 +49,35 @@ PersonView.as_hash(person, context: {current_user: current_user})
 }
 ```
 
+#### 🐒-patching the model
+
+ModelView can add a convenience method to the model class
+
+Example
+```ruby
+class PersonModelView
+  model Person
+  field :id
+end
+
+p = Person.find 1
+
+p.as_hash(context: {current_user: current_user})
+=> {
+  id: 1
+}
+```
+
+When using ModelView in Rails, remember to add an initializer that requires your model views.
+
+Example initializer:
+```ruby
+# require.rb
+Dir["#{Rails.root}/app/model_views/*.rb"].each do |file|
+  require File.basename(file, File.extname(file))
+end
+```
+
 #### Scopes
 
 Scopes allows you to create serialisation snippets that can be composed
@@ -60,7 +89,7 @@ field :id
 scope :demographics do
   field :name
   field(:first_name) { |person| person.name.split(' ').first }
-  field(:last_name) { |person| person.name.split(' ').first }
+  field(:last_name) { |person| person.name.split(' ').last }
 end
 
 scope :status do
@@ -78,13 +107,13 @@ end
 ```ruby
 person = Person.find(1)
 
-PersonView.as_hash(person, context: {current_user: current_user})
+PersonView.as_hash(person, {context: {current_user: current_user}})
 => {
   id: 1
 }
 
 
-PersonView.as_hash(person, context: {current_user: current_user, scope: :demographics})
+PersonView.as_hash(person, {context: {current_user: current_user}, scope: :demographics})
 => {
   id:   1,
   name: "Billy Bob",
@@ -92,7 +121,7 @@ PersonView.as_hash(person, context: {current_user: current_user, scope: :demogra
   last_name: "Bob",
 }
 
-PersonView.as_hash(person, context: {current_user: current_user, scope: :all})
+PersonView.as_hash(person, {context: {current_user: current_user}, scope: :all})
 => {
   id:   1,
   name: "Billy Bob",

data/lib/model_view/version.rb

@@ -1,3 +1,3 @@
 module ModelView
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/model_view.rb

@@ -36,12 +36,21 @@ module ModelView
     @scopes
   end
 
-  def as_hash(object, opts={} )
+  def as_hash(object, opts={})
     scope = opts[:scope] || ROOT
     context = opts[:context] || {}
     ModelView::Resolver.resolve(object, @scopes, scope , context)
   end
 
+  def model(model_class)
+    model_view_class = self
+    model_class.class_eval do
+      define_method(:as_hash) do |opts|
+        model_view_class.as_hash(self, opts)
+      end
+    end
+  end
+
   private
 
   def add_scope(scope_name)

data/spec/model_view/model_view_spec.rb

@@ -143,4 +143,29 @@ describe ModelView do
       end
     end
   end
+
+  describe :model do
+    before do
+      class MyModel
+
+      end
+    end
+
+    it "adds an as_hash method to the model" do
+      dummy_class.model MyModel
+
+      expect(MyModel.new).to respond_to(:as_hash)
+    end
+
+    it "adds an as_hash method to the model that defers to the model view's as_hash method" do
+      dummy_class.model MyModel
+      instance = MyModel.new
+
+      expect(dummy_class).to receive(:as_hash).with(instance, {})
+
+      instance.as_hash({})
+    end
+
+  end
+
 end

metadata

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