creatable 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 805d90e2b323e067b44514cc1e02e3b5fabefea5
-  data.tar.gz: ec25cda1fd8eea6c79d31afba436df330612e5de
+  metadata.gz: 9486fdf6f7b16f7f47017d42137d18fe6122d709
+  data.tar.gz: 3e2a51254d9e8c10444c70e7910b80e90e6a20f8
 SHA512:
-  metadata.gz: e88e6ee823bdc849aeb1b2799c7f4fa3a60c1f7220d7e45efcaa85afa1187b4d95cec3b77474ae3e1b1e5341aad22cd235f55a89097c6bd102bee3ded166e2ca
-  data.tar.gz: a9478111114dd34d92890be5ba17c1a6ff9a9b223b41c0a9e753b8e8d94a73af921774988977f79a4da8ca222461bbea056fe2e99c1aa4e7af1903e37857f12e
+  metadata.gz: c0ffc433467fea9f018fca7feb88b11a57872bf753d643b5539101df7a694130f95e33cccf32e09e96bddad3c2815c06b950560ec8ecbb4a0e7ce5c149428602
+  data.tar.gz: 1b31eae388bcc13cb19848daf15d27bd3a1bee59f624d79b7380983c188525bef89937060b572ca5e6c21f11c04d9844a62a9e021529a787b0d30245dd1bbc02

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 ebrodeur@ujami.net. The project team will review and investigate all complaints, and will respond in a way that it deems 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/Guardfile

@@ -1,19 +1,4 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+clearing :on
 
 guard :bundler do
   require 'guard/bundler'
@@ -27,21 +12,10 @@ guard :bundler do
   files.each { |file| watch(helper.real_path(file)) }
 end
 
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
 guard :rspec, cmd: 'bundle exec rspec' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
-  # Feel free to open issues for suggestions and improvements
-
   # RSpec files
   rspec = dsl.rspec
   watch(rspec.spec_helper) { rspec.spec_dir }
@@ -51,34 +25,6 @@ guard :rspec, cmd: 'bundle exec rspec' do
   # Ruby files
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)
-
-  # Rails files
-  rails = dsl.rails(view_extensions: ['erb', 'haml', 'slim'])
-  dsl.watch_spec_files_for(rails.app_files)
-  dsl.watch_spec_files_for(rails.views)
-
-  watch(rails.controllers) do |m|
-    [
-      rspec.spec.call("routing/#{m[1]}_routing"),
-      rspec.spec.call("controllers/#{m[1]}_controller"),
-      rspec.spec.call("acceptance/#{m[1]}")
-    ]
-  end
-
-  # Rails config changes
-  watch(rails.spec_helper)     { rspec.spec_dir }
-  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
-  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
-
-  # Capybara features specs
-  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
-  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
-  end
 end
 
 unless ENV["DISABLE_RUBOCOP"] == 'true'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ernie Brodeur
+
+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

@@ -1,5 +1,7 @@
 # Creatable
 
+[![CodeFactor](https://www.codefactor.io/repository/github/erniebrodeur/creatable/badge)](https://www.codefactor.io/repository/github/erniebrodeur/creatable)
+
 A mixin that adds a `create` method to any class.
 
 ## Installation
@@ -12,11 +14,11 @@ gem 'creatable'
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install creatable
+    gem install creatable
 
 ## Usage
 

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-midnight

data/creatable.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'creatable/version'

data/lib/creatable.rb

@@ -1,42 +1,18 @@
 require "creatable/version"
+require 'creatable/class_methods'
 
-# include this, documentation will come.
+# Main module you include in your class
 module Creatable
-  def attributes
-    @attributes ||= []
-    @attributes
+  # Override to load the ClassMethods
+  # @param [Object] object
+  # @return [Void]
+  def self.included(object)
+    object.extend ClassMethods
   end
 
-  def attribute(name: nil, type: nil, kind_of: nil)
-    type ||= 'accessor'
-    raise ArgumentError, 'name is a required parameter' unless name
-    raise ArgumentError, "type must be of type: 'accessor', 'reader', or 'writer'" unless ['accessor', 'reader', 'writer'].include? type
-
-    if ['accessor', 'reader'].include?(type)
-      define_method name.to_s do
-        instance_variable_get "@#{name}"
-      end
-    end
-
-    if ['accessor', 'writer'].include?(type)
-      if kind_of.nil?
-        define_method "#{name}=" do |value|
-          instance_variable_set "@#{name}", value
-        end
-      else
-        define_method "#{name}=" do |value|
-          raise ArgumentError, "parameter #{name} (#{value.class}) is not a kind of (#{kind_of})" unless value.is_a?(kind_of) || value.nil?
-          instance_variable_set "@#{name}", value
-        end
-      end
-    end
-
-    attributes.push name.to_sym
-  end
-
-  def create(args = {})
-    object = new
-    attributes.each { |l| object.send "#{l}=".to_sym, args[l] }
-    object
+  # Returns the hash of built attributes
+  # @return [Hash] the name, type, and kind_of built attributes.
+  def attributes
+    self.class.attributes
   end
 end

data/lib/creatable/class_methods.rb

@@ -0,0 +1,54 @@
+module Creatable
+  # Class methods that get mixed in.
+  module ClassMethods
+    # Returns the list of attributes attatched to this object
+    # @return [Hash] the current attributes
+    def attributes
+      @attributes ||= {}
+      @attributes
+    end
+
+    # Replacement for attr_*   Will build the same getter/setter methods.
+    # will also include a kind_of check.
+    # @param [String] name name of the attribute
+    # @param [String] type accessor, reader, or writer
+    # @param [Class] kind_of class that this can be set too
+    # @raise [ArgumentError] if name is not supplied
+    # @raise [ArgumentError] if the type is not accessor, reader, or writer
+    # @return [Void]
+    def attribute(name: nil, type: 'accesor', kind_of: nil)
+      raise ArgumentError, 'name is a required parameter' unless name
+      raise ArgumentError, "type must be of type: 'accessor', 'reader', or 'writer'" unless ['accessor', 'reader', 'writer'].include? type
+
+      if ['accessor', 'reader'].include?(type)
+        define_method name.to_s do
+          instance_variable_get "@#{name}"
+        end
+      end
+
+      if ['accessor', 'writer'].include?(type)
+        if kind_of.nil?
+          define_method("#{name}=") { |value| instance_variable_set "@#{name}", value }
+        else
+          define_method("#{name}=") do |value|
+            raise ArgumentError, "parameter #{name} (#{value.class}) is not a kind of (#{kind_of})" unless value.is_a?(kind_of) || value.nil?
+            instance_variable_set "@#{name}", value
+          end
+        end
+      end
+
+      attributes.merge!(name: name, type: type, kind_of: kind_of)
+      nil
+    end
+
+    # Create a new instance of a given object.   Allows you to pass in any attribute.
+    # @param [Hash] arg key/value pairs for existing attributes
+    # @return [Object] Newly created object
+    def create(arg = {})
+      object = new
+      key, value = arg.flatten
+      attributes.each { |_l| object.instance_variable_set "@#{key}", value }
+      object
+    end
+  end
+end

data/lib/creatable/version.rb

@@ -1,3 +1,3 @@
 module Creatable
-  VERSION = '1.0.1'.freeze
+  VERSION = '2.0.0'.freeze # VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creatable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Ernie Brodeur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -228,18 +228,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
 - creatable.gemspec
 - lib/creatable.rb
+- lib/creatable/class_methods.rb
 - lib/creatable/version.rb
 homepage: https://github.com/erniebrodeur/creatable
 licenses: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.1