cygnet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d948361c254e63d532d93eee85ecef442aca5619db7590f0a6bd7b6feb29e5d
+  data.tar.gz: 49a31d51727643cd75250522695fe617b33e8dcd06ed1fa6de792069dc9f8e92
+SHA512:
+  metadata.gz: 80651de5aec58aeb27b95db96cd15f52c04c32f5832dda23ad0e9a27e52df9569de0b763f343ef4d012ca61396e0413079eb9c5b439a36966ed1dd4311627b92
+  data.tar.gz: b8150afe0a60246640e0180c220818220de04e42b16d56d253f9d36231882236e6c093f1699e0558d6fa28493c83c0a858f6949d64d74761b113034c0cf108bd

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/docs/README.md

@@ -0,0 +1,25 @@
+# Something for Nothing
+
+`cygnet` is currently comprised of two parts:
+
+1. An implementation of the [Null Object Pattern](https://en.wikipedia.org/wiki/Null_Object_pattern), which automatically accounts for nil.
+
+2. An implementation of nested hashes using [DeepStruct](http://andreapavoni.com/blog/2013/4/create-recursive-openstruct-from-a-ruby-hash).
+
+
+## Usage
+
+    $ rails c
+    [1] pry(main)> something = Cygnet::NullObject.new
+    => <#Cygnet::NullObject ...>
+    [2] pry(main)> something.doesnotexist
+    => <#Cygnet::NullObject ...>
+
+    [3] pry(main)> s = Cygnet::DeepStruct.new({foo: {bar: :baz}})
+    => #<Cygnet::DeepStruct foo=#<SometingForNothing::DeepStruct bar=:baz>>
+    [4] pry(main)> s.foo
+    => #<Cygnet::DeepStruct bar=:baz>
+    [5] pry(main)> s.foo.bar
+    => :baz
+    [6] pry(main)> s.bar.foo
+    => #<Cygnet::NullObject:0x007f974c1dc230>

data/lib/cygnet/collections.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cygnet
+  # Builds flattened collections of objects for easy return
+  class MappedCollection < Array
+    def initialize(builder, records) # rubocop:disable Lint/MissingSuper
+      @builder = builder
+      @records = records
+      self << records.map(&builder.method(:new))
+      flatten!
+    end
+  end
+
+  # Easy API for paginated collections
+  class PaginatedCollection < MappedCollection
+    attr_accessor :total_pages, :current_page, :total_entries
+
+    def initialize(builder, records, pagination = {})
+      paginated = records.paginate(pagination)
+
+      @total_pages = paginated.total_pages
+      @current_page = paginated.current_page
+      @total_entries = paginated.total_entries
+
+      super builder, paginated
+    end
+  end
+end

data/lib/cygnet/null_object.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Cygnet
+  # NullObject implements the widely-known NullObject pattern, where an instance
+  # responds to any method called on it by returning another NullObject, allowing
+  # arbitrary chaining of method calls without the risk of a NoMethodError.
+  #
+  # As an exception, NullObject can be cast to other types, taking a neutral
+  # value of that type; it is cast to the empty string, 0, 0.0, the empty Array and Hash, etc.
+  #
+  # Additionally, it identifies positively as #nil? and #blank? for compatability
+  # with common checks on "neutral" or "empty" values by imitating the behaviour of nil.
+  class NullObject
+    def method_missing(*_args, &_block)
+      self
+    end
+
+    def respond_to_missing?(_method_name, _include_private = true)
+      true
+    end
+
+    def nil?
+      true
+    end
+
+    def blank?
+      nil?
+    end
+
+    def !
+      true
+    end
+
+    def to_s
+      ''
+    end
+
+    def to_i
+      0
+    end
+
+    def to_f
+      0.0
+    end
+
+    def to_a
+      []
+    end
+
+    def to_ary
+      []
+    end
+
+    def to_h
+      {}
+    end
+
+    def to_hash
+      {}
+    end
+
+    def to_c
+      Complex(0)
+    end
+
+    def to_r
+      Rational(0)
+    end
+  end
+end

data/lib/cygnet/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cygnet
+  VERSION = '0.0.1'
+end

data/lib/cygnet.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'cygnet/null_object'
+require 'cygnet/collections'
+
+# Better ways to account for nil
+module Cygnet
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: cygnet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carlos Palhares
+- Jill Klang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-powerhome
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.21
+description: Implements the Null Object Pattern and an implmentation of nested hashes
+  using NullObject.
+email:
+- chjunior@gmail.com
+- jillian.emilie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- docs/README.md
+- lib/cygnet.rb
+- lib/cygnet/collections.rb
+- lib/cygnet/null_object.rb
+- lib/cygnet/version.rb
+homepage: https://github.com/powerhome/power-tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Better ways to account for nil.
+test_files: []