poro_plus 1.1.5 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 713cb8476281f79481a01bb821b093e16dcf838b
-  data.tar.gz: e0ca44fe846dd271ff52f4d8cbd38e8bed7a7bfc
+SHA256:
+  metadata.gz: c86fd436ed317e15fb8b3fe9ab82bb173ba5a363bfa3f410aee4ec2b1c3fc740
+  data.tar.gz: 7d9ee0359f5ca0f459468fbc2b4e67a1643a8f360087d5523321feb957155484
 SHA512:
-  metadata.gz: 5deb90139fc376bfe0562d3ef3341339fffdcac0afb63d4eca11682e118ed6ac6b3164449e5ca30857b38fea46696fceb051d55f872cf89e9f62a8dd6926fc3c
-  data.tar.gz: f40b9c727b9472c67a12f24a43d02f66815cf509ddff46698bb61f480d3b3b1a4b2877c646b7a5ac68a1c18ba4de0e9630f4cfc1688c08d67b9fdbff9b07755e
+  metadata.gz: b3e96c1f9c383c8f1744758516c6c94fb6d283ff1cae6532817a2f82f63f8a61d406b0dd8ec83d7726910d6d1db4aa92bd49da2e178faeaca1779d2bcc0636d5
+  data.tar.gz: b21a96599a55c5f75a6ecf433d44eb9b2b46fdcf860f40faed96d2c5c729b570360d7fc3c708a368ad74e5ba2f4cf60906924aa5fa94ea7b6963a5b5c6cd7dda

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at coraline@idolhands.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/Gemfile.lock

@@ -1,21 +1,26 @@
 PATH
   remote: .
   specs:
-    poro_plus (1.1.5)
+    poro_plus (1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.4)
-    rake (10.1.0)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
+    diff-lcs (1.3)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
 
 PLATFORMS
   ruby
@@ -27,4 +32,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.11.2
+   1.16.1

data/README.md

@@ -21,7 +21,7 @@ Simply include PoroPlus into your Ruby class:
 
     class MyThing
       include PoroPlus
-      attr_accessor :foo, :bar, :tres
+      attr_reader :foo, :bar, :tres
     end
 
 Then you can:
@@ -32,9 +32,29 @@ Then you can:
     > thing_1.to_hash
     => {:foo=>"Raven", :bar=>"Writing Desk", :tres=>nil}
 
-    > thing_one.to_json(:skip_nils => true)
+    > thing_1.to_json(:skip_nils => true)
      => "{\"foo\":\"Raven\",\"bar\":\"Writing Desk\"}"
 
+If you want the JSON to include methods that return values:
+
+    class MyThing
+      include PoroPlus
+      attr_reader :foo, :bar, :tres
+
+      def tres
+        "tres leches con #{self.bar}"
+      end
+
+    end
+
+Then, passing a nil to create a placeholder for that JSON attribute, you can:
+
+    > thing_2 = MyThing.new(:foo => 'Taco', :bar => 'cinnammon', :tres => nil) # nil placeholder
+    => #<MyThing:0x007ff4866ea398 @foo="Taco", @bar="cinnammon", @tres=nil>
+
+    > thing_2.to_json(:skip_nils => true)
+     => "{\"foo\":\"Taco\",\"bar\":\"cinnammon\",\"tres\":\"tres leches con cinnammon\"}"
+
 ## Contributing
 
 1. Fork it

data/lib/poro_plus.rb

@@ -8,7 +8,9 @@ module PoroPlus
 
   def to_hash(args={})
     instance_variables.inject({}) do |h, iv|
+      key = sanitized_key(iv)
       value = instance_variable_get(iv)
+      value ||= self.public_send(key) if self.respond_to?(key)
       return h if value.nil? && args[:skip_nils]
       h[sanitized_key(iv)] = value
       h

data/lib/poro_plus/version.rb

@@ -1,3 +1,3 @@
 module PoroPlus
-  VERSION='1.1.5'
-end
+  VERSION='1.2'
+end

data/spec/lib/poro_plus/poro_plus_spec.rb

@@ -6,6 +6,11 @@ describe PoroPlus do
     include PoroPlus
     attr_accessor :foo
     attr_accessor :bar
+    attr_reader :baz
+
+    def baz
+      foo + bar
+    end
   end
 
   describe '#sanitized_key' do
@@ -23,7 +28,7 @@ describe PoroPlus do
       thing.to_hash[:bar].should == 2
     end
 
-    it 'nil-values are not skipped normally' do 
+    it 'nil-values are not skipped normally' do
       thing = Thing.new(foo: 1, bar: nil)
       thing.to_hash[:foo].should == 1
       thing.to_hash[:bar].should be_nil
@@ -31,11 +36,11 @@ describe PoroPlus do
 
     it 'skips nil-value instance variables if so configured with skip_nils flag' do
       thing = Thing.new(foo: 1, bar: nil)
-      thing.to_hash(:skip_nils => true).keys.include?(:bar).should be_false
+      thing.to_hash(:skip_nils => true).keys.include?(:bar).should be_falsey
     end
 
   end
- 
+
   describe '#to_json' do
     it "converts its instance variables to json string" do
       thing = Thing.new(foo: 1, bar: 2)
@@ -54,5 +59,11 @@ describe PoroPlus do
 
   end
 
-end
+  context "with overriding methods" do
+    it "replaces a nil initialized value with a method call" do
+      thing = Thing.new(foo: 1, bar: 2, baz: nil)
+      thing.to_json.should == "{\"foo\":1,\"bar\":2,\"baz\":3}"
+    end
+  end
 
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poro_plus
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: '1.2'
 platform: ruby
 authors:
 - Coraline Ada Ehmke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple methods to make Plain Old Ruby Objects (POROs) more fun.