active_adapter 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb9a0b696b66beeb7ba853513320977fe4640f1e9c7913fc25d83af3629b704c
-  data.tar.gz: 66b86fa974d9e3b7211a36666cb1411a00f1c1ef8cf94f02ad2f172d14cce00a
+  metadata.gz: 1b4167041e496f8892f1517ac5fc2ff1111ab350c065c2625d218077c7ab4db5
+  data.tar.gz: e9b87abaa921e7c998bcbb00efbe6aac698d3aac534565b01eb583484a065bbc
 SHA512:
-  metadata.gz: 0a98bb5e6aad8d41e21713245b9828b088e9b36abc2747c63cf9fda5b430640630998b109fc414de8353841e9c2060b8e6c96e94fabf719f5e0f6324440031f9
-  data.tar.gz: 15da185f9f6a941ac09dc71a50a5a32e9f55df8319a27a83b31094f14f6c5b25ac40dcdad53b3d159c78464ea18d9f20e0f383ba3542c84875391ef580f75ecf
+  metadata.gz: ebc7d39b8baf528e191925d582a4d1a857a8c9f2fd97e10342b98f7fd8ff098abf378dd6ed05745de47786293aa4ab3d449edab1e7997383e47722ae04e4745e
+  data.tar.gz: 36fa12a42e2588b2b91f0f564f92f6d830be01a6be122d200350ff50040c10a94fd3e6c83de4cb4f782b1497052abd6a1a3b7541519fd5562c0432391f0f8295

data/README.md

@@ -1,8 +1,6 @@
 # ActiveAdapter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_adapter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple implementation of the adapter pattern.
 
 ## Installation
 
@@ -22,7 +20,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Define your adaptable classes:
+
+```ruby
+# vehicle.rb
+class Vehicle < ActiveAdapter::Engine; end
+```
+
+```ruby
+# vehicle_adapters/abstract.rb
+class VehicleAdapters::Abstract < ActiveAdapter::Abstract
+  def run
+    adapter.run
+  end
+end
+```
+
+```ruby
+# vehicle_adapters/car.rb
+class VehicleAdapters::Car < ActiveAdapter::Implement
+  def run
+    "Car running..."
+  end
+end
+```
+
+Now you can use the adapter pattern as simple as you see:
+
+```ruby
+vehicle = Vehicle.adapt(:car)
+vehicle.run # => "Car running..."
+```
+
+See complete abilities of ActiveAdapter, please follow [Spec files](https://github.com/pinewong/active_adapter/blob/master/spec/active_adapter_spec.rb)
 
 ## Development
 

data/lib/active_adapter/abstract.rb

@@ -2,6 +2,8 @@ module ActiveAdapter
   class Abstract
     attr_reader :adapter
 
+    # Instance an real object from abstract object by adapter
+    # @param implement_adapter_class [Class] The implement adapter class
     def initialize(implement_adapter_class)
       @adapter = implement_adapter_class.new
     end

data/lib/active_adapter/engine.rb

@@ -1,10 +1,33 @@
 module ActiveAdapter
   class Engine
     class << self
-      def adapters
-        @adapters ||= {}
-      end
-
+      # To adapt engine object for a real object
+      # @param adapter [#to_sym] Adapter class name
+      # @return [Object] The real object with a adapter
+      # @raise [ActiveAdapter::AbstractAdapterUndefinedError] if there is no *_adapters folder or
+      #   there is no abstract class(inherit from ActiveAdapter::Abstract) in *_adapters folder
+      # @raise [ActiveAdapter::ImplementAdapterUndefinedError] if there is no implement class
+      #   inherit from ActiveAdapter::Implement)
+      # @example
+      #   # vehicle.rb
+      #   class Vehicle < ActiveAdapter::Engine; end
+      #
+      #   # vehicle_adapters/abstract.rb
+      #   class VehicleAdapters::Abstract < ActiveAdapter::Abstract
+      #     def run
+      #       adapter.run
+      #     end
+      #   end
+      #
+      #   # vehicle_adapters/car.rb
+      #   class VehicleAdapters::Car < ActiveAdapter::Implement
+      #     def run
+      #       "Car running..."
+      #     end
+      #   end
+      #
+      #   vehicle = Vehicle.adapt(:car)
+      #   vehicle.run # => "Car running..."
       def adapt(adapter)
         adapters[adapter.to_s] ||= begin
           module_name = "#{name.deconstantize}::#{name.demodulize}Adapters"
@@ -17,6 +40,10 @@ module ActiveAdapter
 
       private
 
+      def adapters
+        @adapters ||= {}
+      end
+
       def get_implement_adapter_class(module_name, adapter)
         "#{module_name}::#{adapter.to_s.camelize}".constantize
       rescue NameError => e

data/lib/active_adapter/version.rb

@@ -1,3 +1,3 @@
 module ActiveAdapter
-  VERSION = "0.1.0.pre".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Pine Wong
@@ -144,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6