etter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9402fe25c21a2e68bfd57650804558602c41453
+  data.tar.gz: ad5987ebc8d8c7a98e248db2d24ff07c580f5514
+SHA512:
+  metadata.gz: 49274ba1d414859c9e1ac1309d5c59e5be837dc778123f93eebb0e9959028db8b75d4cb2044399478d3962653b76adadb96b06e3d78f3f29b9f2a2772ed1bfe2
+  data.tar.gz: e80a1095b811b7be7e896c445e6c328bd768f68264016ca81c008e821c18ed9255e60809dac76e0b7b89dca44753cfffded5e4d5604a304d986db09f025bf111

data/lib/etter.rb

@@ -0,0 +1 @@
+require_relative "etter/etter"

data/lib/etter/etter.rb

@@ -0,0 +1,65 @@
+#
+# Top level namespace for Etter. Behaves somewhat like a class, in that you can
+# send +::new+ to it, but will not return anything other than a +String+ or
+# +Sumbol+
+#
+module Etter
+  ERROR = "is not allowed as an instance variable name"
+
+  class << self
+    #call-seq:
+    #  new(string) => string
+    #  new(symbol) => symbol
+    def new(obj)
+      attribute = _attrify(obj)
+      if obj.is_a? Symbol
+        return attribute.intern
+      else
+        return attribute
+      end
+    end
+
+    def getter(obj)
+      _validate_internal obj
+      obj.intern
+    end
+
+    def setter(obj)
+      _validate_internal obj
+      (obj.to_s + "=").intern
+    end
+
+    private
+    def _attrify(obj)
+      _validate_internal(obj)
+      obj = literal2snk(obj)
+      if obj[0] == '@'
+        return obj
+      else
+        return obj.prepend '@'
+      end
+    end
+
+    def literal2snk(obj)
+      rep = obj.to_s.gsub('-', '_')
+      rep
+    end
+
+    def _validate_internal(obj)
+      raise NameError, "`#{obj}' #{ERROR}" unless
+        obj.is_a?(String) || obj.is_a?(Symbol)
+      raise NameError, "`#{obj}' #{ERROR}" unless
+        obj[0] =~ /[a-zA-Z@]/
+      raise NameError, "`#{obj}' #{ERROR}" unless
+        obj.to_s[1..-1].scan(/[^a-zA-Z0-9-]/).empty?
+    end
+
+    def self.extended(mod)
+      raise "cannot extend this module. "
+    end
+
+  end
+end
+
+require_relative "string"
+require_relative "symbol"

data/lib/etter/string.rb

@@ -0,0 +1,13 @@
+class String
+  def to_attr
+    Etter.new self
+  end
+
+  def to_setter
+    Etter.setter self
+  end
+
+  def to_getter
+    Etter.getter self
+  end
+end

data/lib/etter/symbol.rb

@@ -0,0 +1,13 @@
+class Symbol
+  def to_attr
+    Etter.new self
+  end
+
+  def to_setter
+    Etter.setter self
+  end
+
+  def to_getter
+    Etter.getter self
+  end
+end

data/lib/etter/typed.rb

@@ -0,0 +1,137 @@
+require_relative "etter"
+
+#
+# Provides quick and easy ways to set attributes with type restrictions.
+# Also, optionally enforces scoping, in case you have some attributes that you
+# want to remain private or protected but need the dynamic handling allowed
+# by +setter+ and +getter+
+#
+# Of course, in Ruby, type is only a suggestion, and not a requirement,
+# so there are ways of getting around these settings.
+#
+# To use this, +extend+ your class with +Etter::Typed+
+# (+include+ will work... but it doesn't really do you any good)
+module Etter::Typed
+
+  # This method is not very different from +attr_reader+, but is
+  # provided because in the future, it may do something such as
+  # taint the returned object if it does not match the specified
+  # type, or maybe even attempt conversion, e.g.
+  #   class Example
+  #     getter :one,
+  #       type: Integer
+  #     def initialize(one)
+  #       @one = one
+  #       p @one
+  #     end
+  #   end
+  #   ex = Example.new "1"
+  #   # => "1"
+  #   p ex.one
+  #   # => 1
+  # Also provides a +scope+ parameter which can be set to
+  #   :public
+  #   :protected
+  #   :private
+  def getter(name, type: Object, scope: :public)
+    define_method(name.to_getter) do
+      get_attr name
+    end
+
+    case scope
+    when :public, "public"
+      public name.to_getter
+    when :protected, "protected"
+      protected name.to_getter
+    when :private, "private"
+      private name.to_getter
+    else
+      raise NameError, <<~EOF
+        #{scope.inspect} is not a valid scope
+        Did you mean? public
+                      protected
+                      private
+      EOF
+    end
+  end
+
+  #
+  # Like +attr_writer+ except that when the instance methods
+  # it creates are called, the incoming object is checked
+  # against the class provided with the +type+ parameter
+  #
+  # Also provides a +scope+ parameter which can be set to
+  #   :public
+  #   :protected
+  #   :private
+  #
+  def setter(name, type: Object, scope: :public)
+    define_method(name.to_setter) do |value|
+      raise TypeError, "#{name.to_attr} must be a #{type}" unless
+        value.is_a? type
+      set_attr name, value
+    end
+
+    case scope
+    when :public, "public"
+      public name.to_setter
+    when :protected, "protected"
+      protected name.to_setter
+    when :private, "private"
+      private name.to_setter
+    else
+      raise NameError, <<~EOF
+        #{scope.inspect} is not a valid scope
+        Did you mean? public
+                      protected
+                      private
+      EOF
+    end
+  end
+
+  #
+  # Like +attr_accessor+ , but encompasses the properties mentioned
+  # in +setter+ and +getter+
+  #
+  def property(name, type: Object, scope: :public)
+    getter name,
+      type: type,
+      scope: scope
+
+    setter name,
+      type: type,
+      scope: scope
+  end
+
+  private
+  def self.extended(mod)
+    mod.include(InstanceMethods)
+  end
+
+  #
+  # Automatically +include+ d when +Etter::Typed+ extends
+  # a class
+  #
+  module InstanceMethods
+    private
+
+    #
+    # Gets an instance variable, accepting either of the following:
+    #   get_attr :name
+    #   get_attr :@name
+    #
+    def get_attr(name) # :doc:
+      instance_variable_get Etter.new(name)
+    end
+
+    #
+    # Sets an instance variable, accepting either of the following:
+    #   set_attr :name, "value"
+    #   set_attr :@name, "value"
+    #
+    def set_attr(name, value) # :doc:
+      instance_variable_set Etter.new(name), value
+    end
+  end
+
+end

data/lib/etter/version.rb

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

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: etter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Frederick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-14 00:00:00.000000000 Z
+dependencies: []
+description: "...for Classes and Instances!"
+email:
+- galvertez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/etter.rb
+- lib/etter/etter.rb
+- lib/etter/string.rb
+- lib/etter/symbol.rb
+- lib/etter/typed.rb
+- lib/etter/version.rb
+homepage: https://github.com/galvertez/etter
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Setters and Getters and Properties...
+test_files: []