clear_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29c974d39f2d2ab2b48f252e48f04b8b716e4433ff05e6285a4ce202333858c8
+  data.tar.gz: 708b56f5e102509e39732388da089ed93c5393011de2d729065b870ada1d1481
+SHA512:
+  metadata.gz: 9b9e335530af1b146ca1ad09bb255479bb6684b0c905b7b5e1318987c66dcb29a3101f4f3ad5c236c6dae3010e373e31b9f48eca9ff38f967ea835b536ee9db4
+  data.tar.gz: 9b9569b82ec83cc8da7bbcd143ecfe28b822cd9dc70a535c1e6d079e24a396eadddef8d62d2da36bfbe6cbde7ebfb9834962d245f2575f6796d0821f189c3fd2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**/*.swp
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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, gender identity and expression, level of experience,
+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 wizard.oneandonly@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in clear_object.gemspec
+gemspec
+gem 'zeitwerk', '~> 2.1'

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    clear_object (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    zeitwerk (2.1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  clear_object!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  zeitwerk (~> 2.1)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stefan Slaveykov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# ClearObject
+
+`clear_object` helps you define your ruby objects(classes) without the need for a lot of boilerplate code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clear_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clear_object
+
+## Usage
+Imagine the following ruby class:
+```ruby
+class Address
+  attr_reader :city, :street
+
+  def initialize(city:, :street)
+   @city = city
+   @street = street
+  end
+
+  def location
+    "#{city}, #{street}"
+  end
+end
+
+class User
+  attr_reader :name, :email, :address
+
+  def initialize(name:'Jo', email: nil, address: Address.new)
+    @name = name
+    @address = address
+    @email = email
+  end
+
+  def location
+    address.location
+  end
+end
+```
+
+clear_object gives you exactly the same code, but reduces the boilerplate
+
+```ruby
+class User
+  extends ClearObject
+
+  clear :name, default: 'Jo'
+  clear :email, default: nil
+  clear :address do
+    clear :city, :street
+    def location
+      "#{city} #{street}"
+    end
+  end
+end
+```
+It will 'secretly' define an `Address` class for you under the hood in case you supply a block. You have control over the name of the class via the `:class_name` option.
+The `default` option will accept anything, including a callable object
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clear_object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ClearObject project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clear_object/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clear_object"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clear_object.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clear_object/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clear_object"
+  spec.version       = ClearObject::VERSION
+  spec.authors       = ["Stefan Slaveykov"]
+  spec.email         = ["wizard.oneandonly@gmail.com"]
+
+  spec.summary       = %q{Helps you build objects without boilerplate.}
+  spec.homepage      = "https://github.com/wizardone/clear_object"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = ""
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/wizardone/clear_object"
+  spec.metadata["changelog_uri"] = "https://github.com/wizardone/clear_object/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/clear_object.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: false
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ClearObject
+  class Error < StandardError; end
+
+  def clear(*attributes, default: nil, **opts, &block)
+    attributes.each do |c_attr|
+      attr_reader c_attr
+
+      if block_given?
+        klass = Class.new do
+          extend ClearObject
+          class_eval(&block)
+        end
+        # How come this is working?
+        Object.const_set((opts[:clear_name] || c_attr).to_s.capitalize, klass)
+      end
+      clear_attributes << Attribute.new(name: c_attr, default: default)
+    end
+
+    class_eval(custom_initialize_def)
+  end
+
+  def clear_get_default_for(name)
+    value = clear_attributes.detect { |c_attr| c_attr.name == name }.default
+    if value.respond_to?(:call)
+      value.call
+    else
+      value
+    end
+  end
+
+  private    
+  def clear_attributes
+    @clear_attributes ||= AttributeSet.new
+  end
+
+  def custom_initialize_def
+    initialize_def = clear_attributes.map do |c_attr|
+      if c_attr.default
+        "#{c_attr.name}: self.class.clear_get_default_for(:#{c_attr.name})"
+      else
+        "#{c_attr.name}:"
+      end
+    end.join(', ')
+
+    initialize_body = ''.tap do |init_body|
+      clear_attributes.each do |c_attr|
+        init_body << "@#{c_attr.name} = #{c_attr.name}\n"
+      end
+    end
+
+    %Q{
+      def initialize(#{initialize_def})
+        #{initialize_body}
+      end
+    }
+    end
+  end

data/lib/clear_object/attribute.rb

@@ -0,0 +1,3 @@
+module ClearObject
+  Attribute = Struct.new(:name, :default, keyword_init: true)
+end

data/lib/clear_object/attribute_set.rb

@@ -0,0 +1,9 @@
+module ClearObject
+  class AttributeSet < Set
+    def <<(attribute)
+      if none? { |member| member.name == attribute.name}
+        add(attribute)
+      end
+    end
+  end
+end

data/lib/clear_object/version.rb

@@ -0,0 +1,3 @@
+module ClearObject
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: clear_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Slaveykov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- wizard.oneandonly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clear_object.gemspec
+- lib/clear_object.rb
+- lib/clear_object/attribute.rb
+- lib/clear_object/attribute_set.rb
+- lib/clear_object/version.rb
+homepage: https://github.com/wizardone/clear_object
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wizardone/clear_object
+  source_code_uri: https://github.com/wizardone/clear_object
+  changelog_uri: https://github.com/wizardone/clear_object/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Helps you build objects without boilerplate.
+test_files: []