passive_model 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4426f301237fd27c3c333bcc688149310fdce4d57621bd026b6baa6f64fd621e
-  data.tar.gz: b0ed7ec5617fa39d2b9fe8ce12be19c8e67e45f316e4d692180d04ba4a6600a6
+  metadata.gz: cb48ebe8a0f354a6ef8ecebbbed4f8257854e09844ad57c5c82fdb09ef42e5ad
+  data.tar.gz: ea06363924c66cba7055becfc87b21a2fd025bc65f47b35d944797cb52d237ee
 SHA512:
-  metadata.gz: '039752fb9fdee6627266c430d44e303564623b692d2f9f9184fd5f284435d79b0308790ac62343142563b684da01c5695bd749eb7a88a78b4e81f8654cfe235a'
-  data.tar.gz: 9f7e1b1b562be197c2bd082d6affca432f0a8cfb0ea66c407cb87d390f2ab7b58ec760f43fd4a288aa02dadcabc036a3f9c2ef26ae28deef1c9ed6efe57e4f53
+  metadata.gz: c04ee7e7796735256f9dc3182121c272948a76cd00cee3db28d4812ae4cceaf848ea49f2890bddf16a0dabf47a3c1537287386919997a8ebb2a4b8231ea968b2
+  data.tar.gz: f06ec4476ae3e822fed9b494fb96a7c4d2d8a7205ecf44e5eeb5bfb99d88af926b67a4ff162d436d8862a38604ad3ac63f69301f661b0a5eb54d2f54ef93ca81

data/README.md

@@ -1,15 +1,15 @@
-# RailsNonPersistentModel
+# PassiveModel
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_non_persistent_model`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a gem for using Rails ActiveModel functionalities without having an actual database table.
 
-TODO: Delete this and the text above, and describe your gem
+Supports validation, callbacks etc. And behaves like a model object, so can be replaced with actual model objects.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rails_non_persistent_model'
+gem 'passive_model'
 ```
 
 And then execute:
@@ -18,19 +18,78 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install rails_non_persistent_model
+    $ gem install passive_model
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a class from `PassiveModel::Base`.
 
-## Development
+For example:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```erbruby
+class ContactForm < PassiveModel::Base
+  attr_accessor :first_name, :last_name
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  validates :first_name, presence: true
+  validates :last_name, presence: true
+  validate :first_name_is_not_spam
+  
+  private
+  
+  def first_name_is_not_spam
+    return if first_name.downcase != 'test'
 
-## Contributing
+    errors.add(:first_name, 'is not valid')
+  end
+end
+```
+
+#### Create new objects 
+
+`form = ContactForm.new(first_name: 'John', last_name: 'Doe')`
+
+#### Set attributes
+
+`form.attributes = { first_name: 'Lewis' }`
+
+#### Emulate a save
+
+It runs the validations and also calls `before_save` callbacks if the object is valid
+
+`form.save # returns true if valid?`
+
+#### Emulate a save!
+
+Raise an error if cannot be saved
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_non_persistent_model.
+`form.save!`
+
+#### persisted?
+
+Return if save has been called
+
+`form.persisted?`
+
+#### before_save callback
+
+Add a callback as follows:
+
+```erbruby
+class ContactForm < PassiveModel::Base
+  before_save :send_info_to_mailchimp
+  
+  validate :first_name, presence: true
+  
+  private
+  
+  def send_info_to_mailchimp
+    # API call  
+  end
+end
+```
+
+The callback will be executed only if validations are clear.
+
+## Contributing
 
+If you need more functionality, for bug reports raise a request at https://github.com/RocketApex/passive_model

data/lib/passive_model/version.rb

@@ -1,3 +1,3 @@
 module PassiveModel
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passive_model
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jey Geethan