eapi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eaa6b7386dfe974f725d80fa008f3d8dbe5ee46
-  data.tar.gz: a9b8fb3d839460128e7595c11db9754b18ac0347
+  metadata.gz: ce4210341572090ddcab6a924eef6512c26790a8
+  data.tar.gz: 1773ccd9aa977cd193f4efd802cc1a11abe6d2b4
 SHA512:
-  metadata.gz: f6cd68cc945520b4e4eaf62a8f60be1f53e06bd21226befb7817cfcefeb01168d04dd75cb7491eae835cd2aa1b24cf3321d838fa56bae973f709b05b191c5db2
-  data.tar.gz: d5688563cada1584200aa2ca6febca6303fba83115484a3dfe80e103dda2282fdb5a7dc3871aa9858415a9eb8f478669ffd255ed674bbb6b63a9a5d00fc67d06
+  metadata.gz: 2c9beaa7358443dee5acdc658dd422a679376c2a29af2db1d6efdc780c47020ea8fc69c2aa2bdeb2e8d5c9b098544fd1a6bf1cb785eb18cc38ce85c9b588f682
+  data.tar.gz: f4d071de2e5e10e4300509088e3f60fcd6d173a1492766f95eab6600bb991ae28e77eda3b2d0484ed003a51432c5f2480700bec076b17804c85934d7c1856f78

data/README.md

@@ -516,6 +516,50 @@ obj.is_an_one_thing? # => true
 obj.is_a_super_duper_thing? # => false
 ```
 
+### Use in your own library
+
+You can add the functionality of Eapi to your own library module, and use it instead of `Eapi::Common`.
+
+Method-call-initialise shortcut can ignore the base name:
+
+```ruby
+module MyExtension
+  extend Eapi
+end
+
+class TestKlass
+  include MyExtension::Common
+  property :something
+end
+
+obj = MyExtension.test_klass something: 1
+obj.something # => 1
+
+
+# if the class is in the same module, it can be omitted when using the object creation shortcut
+
+module MyExtension
+  class TestKlassInside
+    include MyExtension::Common
+    property :something
+  end
+end
+
+obj = MyExtension.my_extension_test_klass_inside something: 1
+obj.something # => 1
+
+obj = MyExtension.test_klass_inside something: 1
+obj.something # => 1
+```
+
+### important note:
+
+As it works now, the children of your extension will be also children of `Eapi`, so calling `Eapi.your_klass` and `YourExtension.your_klass` will do the same.
+
+## TODO
+
+1. `type` option in property definition to accept symbol -> if a class can be recognised by that name, it works ok. If not, it still uses that for type validation (using `is?`) but it does not use that in the `init_` method.
+
 ## Contributing
 
 1. Fork it ( https://github.com/eturino/eapi/fork )

data/lib/eapi.rb

@@ -13,12 +13,24 @@ require 'eapi/common'
 
 
 module Eapi
-  def self.method_missing(method, *args, &block)
-    klass = Eapi::Children.get(method)
-    if klass
-      klass.new *args, &block
-    else
-      super
+  def self.add_method_missing(klass)
+    def klass.method_missing(method, *args, &block)
+      child_klass = Eapi::Children.get(method, self)
+      if child_klass
+        child_klass.new *args, &block
+      else
+        super
+      end
     end
   end
+
+  add_method_missing self
+
+  def self.extended(mod)
+    mod.class_eval <<-CODE
+      Common = Eapi::Common
+      Children = Eapi::Children
+    CODE
+    Eapi.add_method_missing mod
+  end
 end

data/lib/eapi/children.rb

@@ -11,20 +11,36 @@ module Eapi
       CHILDREN[k] = klass
     end
 
-    def self.get(klass_name)
-      k = self.key_for klass_name
-      CHILDREN[k] ||
-        CHILDREN[k.gsub('__', '/')] ||
-        CHILDREN.select { |key, _| key.gsub('/', '_') == k }.values.first
+    def self.get(klass_name, base_class = nil)
+      k = key_for klass_name
+
+      find(k) || find_bare(base_class, k)
     end
 
     def self.has?(klass_name)
       !!self.get(klass_name)
     end
 
+    private
+    def self.find(k)
+      CHILDREN[k] ||
+        CHILDREN[k.gsub('__', '/')] ||
+        CHILDREN.select { |key, _| key.gsub('/', '_') == k }.values.first
+    end
+
     def self.key_for(klass_name)
       k = klass_name.to_s
       k.underscore
     end
+
+    def self.find_bare(base_class, k)
+      if base_class.present?
+        base_key = key_for(base_class)
+        find "#{base_key}/#{k}"
+      else
+        nil
+      end
+    end
+
   end
 end

data/lib/eapi/common.rb

@@ -1,11 +1,22 @@
 module Eapi
   module Common
-    extend ActiveSupport::Concern
-    included do |klass|
+    def self.add_features(klass)
       Eapi::Children.append klass
       klass.send :include, ActiveModel::Validations
       klass.send :include, Eapi::Methods::Properties::InstanceMethods
       klass.send :include, Eapi::Methods::Types::InstanceMethods
+
+      klass.send :extend, ClassMethods
+    end
+
+    def self.extended(mod)
+      def mod.included(klass)
+        Eapi::Common.add_features klass
+      end
+    end
+
+    def self.included(klass)
+      Eapi::Common.add_features klass
     end
 
     def initialize(** properties)

data/lib/eapi/version.rb

@@ -1,3 +1,3 @@
 module Eapi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/extension_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Eapi do
+
+  context 'extension in other modules' do
+    module MyExtension
+      extend Eapi
+    end
+
+    class MyExtensionExternalKlass
+      include MyExtension::Common
+
+      property :something
+    end
+
+    module MyExtension
+      class TestKlass
+        include MyExtension::Common
+
+        property :something
+      end
+    end
+
+    describe 'creates a MyExtension::Common module that works as Eapi::Common' do
+      it 'adds classes that includes the new module to Eapi children' do
+        expect(Eapi::Children).to be_has MyExtensionExternalKlass
+        expect(MyExtension::Children).to be_has MyExtensionExternalKlass
+
+        expect(Eapi::Children).to be_has MyExtension::TestKlass
+        expect(MyExtension::Children).to be_has MyExtension::TestKlass
+      end
+    end
+
+    describe 'creation shortcut' do
+      it 'allows the new module to be used for object creation shortcut' do
+        obj = MyExtension.my_extension_external_klass something: 1
+        expect(obj.to_h).to eq({something: 1})
+      end
+
+      describe 'if classes are inside the module, the name can be ignored with creation shortcut' do
+        it 'MyExtension.test_klass(..) => MyExtension::TestKlass.new(..)' do
+          obj = MyExtension.test_klass something: 1
+          expect(obj).to be_a_kind_of MyExtension::TestKlass
+          expect(obj.to_h).to eq({something: 1})
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -195,6 +195,7 @@ files:
 - lib/eapi/version.rb
 - spec/basic_spec.rb
 - spec/definition_spec.rb
+- spec/extension_spec.rb
 - spec/function_spec.rb
 - spec/list_spec.rb
 - spec/spec_helper.rb
@@ -229,6 +230,7 @@ summary: ruby gem for building complex structures that will end up in hashes (in
 test_files:
 - spec/basic_spec.rb
 - spec/definition_spec.rb
+- spec/extension_spec.rb
 - spec/function_spec.rb
 - spec/list_spec.rb
 - spec/spec_helper.rb