condensable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6ea08e4308bdf976b25b1f70487fb7137b4db98
-  data.tar.gz: 0ff5ce4b1c839155adeab6271b99c5f052453723
+  metadata.gz: b8185f13ee6b748f2c4c635e756dc3620bf01bf2
+  data.tar.gz: 09b453e7b3a4d9eee56c31bd2f84d6b3b076a183
 SHA512:
-  metadata.gz: 1b95ac4d80a2f650c9b1e0247ec18543144a4cb6b68ef183107a1677f58ecdbfd420ae4c24c2309ba67b42853b573b69aa89f4edbf287a39335879ef7bcd1a8f
-  data.tar.gz: e6452e087c9bc95a6986381a7e5384adb44a6680313e660f78c59a16d4778549e51d677206bd10d09589b5deebb6db1b6cb987e7589f804a35604208c66c11a1
+  metadata.gz: 1fed5effcba967ed6a83634835a8a30edf0825398d531afb3ee4c4eed53fb2b695d1e22ed3abe46ddd9c5ca0a6d6e4846a02c6eae1cbb1e5ba3b405ccc0b46eb
+  data.tar.gz: a3e15e61ff992b80f2f517fefa932e2c3e195f55fe483051fd0dd97d6d042f8ab025c72f48315016ae647caf651e379febe88674b43c500107cc3bc5f6866fc2

data/README.md

@@ -1,8 +1,13 @@
 # Condensable
 
-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/blackhole`. To experiment with that code, run `bin/console` for an interactive prompt.
+[ ![Codeship Status for saveav/condensable](https://codeship.com/projects/ba0907e0-5c16-0133-cf88-42612c8c8541/status?branch=master)](https://codeship.com/projects/110913)
 
-TODO: Delete this and the text above, and describe your gem
+In chemistry, condensation is the process of vapour or gas to become a liquid. But,
+this is no chemistry things. Here, condensable is describing a condition of a class
+that allow to make itself respond to getter and setter routines when they are not 
+(yet) defined.
+
+Condensation works well with [Assignbot](https://rubygems.org/gems/assignbot)!
 
 ## Installation
 
@@ -22,18 +27,89 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Simple enough, just include `Condensable` into your class and you are set.
+
+```ruby
+class OrderParams
+  include Condensable
+end
+```
 
-## Development
+And, you can use your condensable instance as follow:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+order = OrderParams.new
+order.order_id = 12
+order.customer = "Adam Pahlevi Baihaqi"
+```
+
+Notice that both `order_id` and `customer` have not yet been defined, but a condensable
+class would automatically define that on-demand.
+
+### Specifying default condensation behaviour
+
+By default, when a getter is not available, a condensable instance will return nil:
+
+```ruby
+order.shipping_address == nil # true
+```
+
+To alter the default behaviour, specify `condensable default` in your class, like below:
+
+```ruby
+class OrderParams
+  include Condensable
+
+  condensable default: "not-available"
+end
+```
+
+Therefore, when invoked:
+
+```
+order.shipping_address
+```
 
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+It will returns `not-available`.
+
+There are 4 condensation behaviours:
+
+1. Returning nil (`condensable default: nil`)
+2. Returning string (`condensable default: "some string"`)
+3. Executing a method, by always passing a symbol (`condensable default: :execute_method`)
+4. Raising an error (`condensable default: :raise_error`)
+
+For more details, please see the spec which demonstrates the all four.
+
+### Iterating condensed variables
+
+To get to know what are all the condensed variables, use:
+
+```ruby
+order.condensed_variables
+```
+
+To get to know all of condensed values, use:
+
+```ruby
+order.condensed_values
+```
+
+Iterating both:
+
+```ruby
+order.each do |condensed_var, condensed_value|
+  puts "#{condensed_var}: #{condensed_value}"
+end
+```
+
+### Checking whether an attribute is a result of condensation
+
+```ruby
+order.is_condensed?(:order_id)          # ==> true
+order.is_condensed?(:shipping_address)  # ==> false
+```
 
-## Contributing
+## License
 
-1. Fork it ( https://github.com/[my-github-username]/condensable/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+The gem is proudly available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/condensable/gravity_absorber.rb

@@ -6,22 +6,63 @@ module Condensable
       base.extend(GravityAbsorber::ClassLevelMethods)
     end
 
+    # list all condensed variables
+    def condensed_variables
+      @condensed_variables = [] if @condensed_variables.nil?
+      @condensed_variables 
+    end
+
+    # check whether a variable is a result of condensation
+    def is_condensed?(variable_name)
+      @condensed_variables.include?(variable_name.to_sym)
+    end
+
+    # all condensed variables' value
+    def condensed_values
+      values = []
+      condensed_variables.each do |var|
+        values << send(var)
+      end
+      values
+    end
+
+    # iterating all condensed variables and its value
+    def each
+      condensed_variables.each do |var|
+        yield var, send(var)
+      end
+    end
+
     def method_missing(method_name, *args, &block)
       if method_name.to_s[-1] == '='
+        @condensed_variables = [] if @condensed_variables.nil?
         # get proper attribute name, by removing "="
         attribute_name = method_name[0..-2]
-        instance_eval do
-          eval %Q{
-            def #{attribute_name}=(arg)
-              @#{attribute_name} = arg
-            end
-            def #{attribute_name}
-              @#{attribute_name}
-            end
-          }
-        end # instance eval
-
-        send(method_name, *args)
+        setter_name = "#{attribute_name}="
+        getter_name = attribute_name
+
+        unless respond_to?(setter_name)
+          instance_eval do
+            eval %Q{
+              def #{attribute_name}=(arg)
+                @#{attribute_name} = arg
+              end
+            }
+          end
+        end
+
+        unless respond_to?(getter_name)
+          instance_eval do
+            eval %Q{
+              def #{attribute_name}
+                @#{attribute_name}
+              end
+            }
+          end # instance eval
+          @condensed_variables << getter_name.to_sym
+        end
+
+        send(setter_name, *args)
       else
         condensable_missing_attribute(method_name, *args)
       end
@@ -43,6 +84,6 @@ module Condensable
       elsif default_handle_arg.is_a?(String)
         return default_handle_arg
       end
-    end
-  end
-end
+    end # condensable missing attribute
+  end # gravity absorber
+end # condensable

data/lib/condensable/version.rb

@@ -1,3 +1,3 @@
 module Condensable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: condensable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Pahlevi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-24 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler