ocioso 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2498705c550427b0f715e3d5ddfa349e32d875c
+  data.tar.gz: 70f9242b356988243d5ecc808bf18507872f4aa3
+SHA512:
+  metadata.gz: a09486e7eb9968baa8139ad2b82f36fb7c826519c21927e8dc1fe1cfa2c423767fd8e4061892b79e8811a22f4d394e7e0e618d40b0865b3c1d5778dc2454f79b
+  data.tar.gz: 2f82056475cfe684ca1e21f57d0b6fab9284fc71983b546748a28cf33d6837cd25b07964c5ebc1604679014c3842f1987304147eb215edce6bbc49ff0032dda3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Julio Lopez
+
+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,110 @@
+# Ocioso
+
+Micro Library for initialize objects
+
+## Installation
+
+Installing Ocioso is as simple as running:
+
+```
+$ gem install ocioso
+```
+
+Include Ocioso in your Gemfile with gem 'ocioso' or require it with require 'ocioso'.
+
+Usage
+-----
+
+You can automatically instance variables without write an initialize method, just send a hash with your name variables and its values when you instantiate a class.
+
+```ruby
+class User
+  include Ocioso
+end
+
+user = User.new name: "Julio", email: "julio@email.com"
+
+# This is the same thing of do:
+# class User
+#   def initialize(name, email)
+#     @name = name
+#     @email = email
+#   end
+# end
+
+puts user.inspect
+#=> <User @name = "Julio", @email = "julio@email.com">
+```
+
+If you define your writer methods you can initialize your variables using a block:
+
+```ruby
+class User
+  include Ocioso
+  attr_writer :name, :email
+end
+
+user = User.new do |user|
+         user.name = "Julio"
+         user.email = "julio@email.com"
+       end
+
+puts user.inspect
+#=> <User @name = "Julio", @email = "julio@email.com">
+```
+
+## Allow certain Values
+
+If you want to only allow some certain variables, you can use `initialize_only_with` method. Other sent variables that haven't been specified won't be initializated.
+
+```ruby
+class User
+  include Ocioso
+  initialize_only_with :name
+end
+
+user = User.new name: "Julio", age: 25
+puts user.inspect
+#=> <User @name = "Julio">
+```
+
+## Default Values
+
+You can define your default values for your instance variables using the `initialize_defaults` method.
+
+```ruby
+class User
+  include Ocioso
+  initialize_defaults name: "Julio", email: "my_email@email.com"
+end
+
+# This is the same thing of do:
+# class User
+#   def initialize(name = "Julio", email = "my_email@email.com")
+#     @name = name
+#     @email = email
+#   end
+# end
+
+user = User.new
+puts user.inspect
+#=> <User @name = "Julio", @email = "my_email@email.com">
+
+other_user = User.new name: "Piero"
+puts other_user.inspect
+#=> <User @name = "Piero", @email = "my_email@email.com">
+```
+
+## Open to Initialize
+
+You can still use your initialize method to do whatever you need, just not forget to send the `super` method to handle the initialize of Ocioso.
+
+```ruby
+class User
+  include Ocioso
+  def initialize(*args)
+    super(*args)
+    #doing whatever
+  end
+end
+```

data/lib/ocioso.rb

@@ -0,0 +1,61 @@
+# Copyright (c) 2015 Julio Lopez
+
+# 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.
+module Ocioso
+  VERSION = "1.0.0"
+  class << self
+    attr_reader :defaults, :values_allowed
+  
+    def included(base)
+      @defaults ||= {}; @values_allowed ||= {}
+      base.extend ClassMethods
+    end
+
+    def get_values(klass)
+      [values_allowed[klass], defaults[klass]]
+    end
+  end
+
+  def initialize(vars = {}, &block)
+    super()
+    _a, _d = Ocioso.get_values(self.class)
+    vars = _d.attributes.merge(vars) if _d
+    vars.each do |k, v|
+      instance_variable_set "@#{k}", v if (_a && _a.include?(k) || _a.nil? )
+    end
+    yield self if block_given?
+  end
+
+  module ClassMethods
+    def initialize_defaults(defaults={})
+      Ocioso.defaults[self] = DefaultParameters.new defaults
+    end
+
+    def initialize_only_with(*args)
+      Ocioso.values_allowed[self] = args
+    end
+  end
+
+  class DefaultParameters
+    attr_reader :attributes
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+  end
+end

data/ocioso.gemspec

@@ -0,0 +1,20 @@
+require "./lib/ocioso"
+
+Gem::Specification.new do |s|
+  s.name              = "ocioso"
+  s.version           = Ocioso::VERSION
+  s.summary           = "Micro Library for initialize objects"
+  s.description       = "Micro Library for initialize objects"
+  s.authors           = ["Julio Lopez"]
+  s.email             = ["ljuliom@gmail.com"]
+  s.homepage          = "http://github.com/TheBlasfem/ocioso"
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb"
+  ]
+  s.license           = "MIT"
+  s.add_development_dependency "cutest", "1.1.3"
+end

data/test/test_ocioso.rb

@@ -0,0 +1,85 @@
+require File.expand_path("../lib/ocioso", File.dirname(__FILE__))
+
+scope do
+  class User
+    include Ocioso
+    attr_accessor :name, :email
+  end
+
+  test "init blank" do
+    user = User.new
+    assert_equal user.is_a?(User), true
+    assert_equal user.instance_variable_get("@name"), nil
+  end
+
+  test "instance variables" do
+    user = User.new name: "Julio", email: "julio@email.com"
+    assert_equal user.instance_variable_get("@name"), "Julio"
+    assert_equal user.instance_variable_get("@email"), "julio@email.com"
+  end
+
+  test "init with block" do
+    user = User.new do |user|
+      user.name = "Claudia"
+      user.email = "clau@email.com"
+    end
+    assert_equal user.name, "Claudia"
+    assert_equal user.email, "clau@email.com"
+  end
+
+  test "init mix, sending hash and block" do
+    user = User.new name: "Piero" do |user|
+      user.email = "piero@email.com"
+    end
+    assert_equal user.name, "Piero"
+    assert_equal user.email, "piero@email.com"
+  end
+
+  test "init with defaults" do
+    class User
+      initialize_defaults name: "Julio"
+    end
+    user = User.new
+    assert_equal user.instance_variable_get("@name"), "Julio"
+  end
+
+  test "customizing defaults" do
+    class User
+      initialize_defaults name: "Julio", email: "julio@gmail.com"
+    end
+    user = User.new name: "Piero"
+    assert_equal user.instance_variable_get("@name"), "Piero"
+    assert_equal user.instance_variable_get("@email"), "julio@gmail.com"
+  end
+
+  test "initialize_defaults dont work with inheritance" do
+    class User
+      initialize_defaults name: "Julio"
+    end
+    class Admin < User; end
+    admin = Admin.new
+    assert_equal admin.instance_variable_get("@name"), nil
+  end
+
+  test "initialize only with" do
+    class DemoUser
+      include Ocioso
+      initialize_only_with :name, :email
+    end
+    user = DemoUser.new name: "Julio", age: 23
+    assert_equal user.instance_variable_get("@name"), "Julio"
+    assert_equal user.instance_variable_get("@age"), nil
+  end
+
+  test "respecting the initialize method" do
+    class User
+      def initialize(*args)
+        super(*args)
+        @ivar = "i'm alive!"
+      end
+    end
+    user = User.new surname: "Lopez"
+    assert_equal user.instance_variable_get("@surname"), "Lopez"
+    assert_equal user.instance_variable_get("@ivar"), "i'm alive!"
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ocioso
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julio Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: Micro Library for initialize objects
+email:
+- ljuliom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ocioso.rb
+- ocioso.gemspec
+- test/test_ocioso.rb
+homepage: http://github.com/TheBlasfem/ocioso
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Micro Library for initialize objects
+test_files: []