durable_decorator_rails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 586bc690be14cb2a9a7fb636c8ee6184060c4075
-  data.tar.gz: 2e07636a2f2ce53f635e09d0ae3740c799ff5c27
+  metadata.gz: 36b186cdfc6de77521d61625035d028f63ff1aee
+  data.tar.gz: 173de9339c8f7a676ae600e45c205778af3a6a68
 SHA512:
-  metadata.gz: 4ed75e77aa972404f78ff35753b506f04dac1449744d1826c929db7240ccb2e9f27a4edfee9a855a6059c93dcc6c67028b828de9993127e5a816582ee9522245
-  data.tar.gz: ee7828bc97f9407b757d2a1921fde7b5ffc7cd0569afef2665616642da3c6aa8910a2be240031e045cd5cb1782d06fe890b2ef202e2730c3a6fcba84ac49cf77
+  metadata.gz: bf7fc9a3712f138bda6cc9b96227b3310ee8e296b0e952bdb233c2e16caa844d804bd1f02e34a27bc883adc30d2dfd4a0a6d331ced0133dbe6e73c31e492f7d4
+  data.tar.gz: 792b6f3cbeb9ad34f2cb66107245d28c7bd9f41a67efe9900d480a3490da4613ee20b13b151db1c9065dd5ace49dbd20a76f3f531eb8172b4f23a942f57fd1a8

data/README.md

@@ -19,12 +19,12 @@ Or install it yourself as:
 ## Usage
 This gem will generate the correct file structure, place (or append to) the correct decorator and even insert the correct seal for you. Use:
 ```shell
-rails g durable_decorator:decorator [SUBDIR] [FULL_METHOD_NAME]
+rails g decorator [FULL_METHOD_NAME]
 ```
 
 For example, let us decorate the an existing ```#deleted?``` instance method from the gem that is namespaced under ```Spree``` in a file that is a *model* called ```Product```. Just run:
 ```shell
-rails g durable_decorator:decorator models Spree::Product#deleted?
+rails g decorator Spree::Product#deleted?
 ```
 
 The gem will create the ```app/models/spree/product_decorator.rb``` file for you to start with, and it will have the following contents:

data/lib/durable_decorator_rails.rb

@@ -2,6 +2,7 @@ require 'durable_decorator'
 require "durable_decorator_rails/version"
 require "durable_decorator_rails/railtie"
 require "durable_decorator_rails/durable_decorator_ext"
+require "durable_decorator_rails/class_type_extractor"
 
 module DurableDecoratorRails
 end

data/lib/durable_decorator_rails/class_type_extractor.rb

@@ -0,0 +1,49 @@
+module DurableDecoratorRails
+  class ClassTypeExtractor
+    class << self
+      def decorator_path method_name
+        type = determine_class_type method_name
+        
+        dir = if type == 'lib'
+          type
+        else
+          "app/#{type}"
+        end
+
+        suffix = namespace method_name
+        dir += "/#{suffix}" if suffix
+
+        dir
+      end
+
+      def determine_class_type method_name
+        class_location_directory method_name
+      end
+      
+      def class_location_directory method_name
+        method_source(method_name).gsub(class_location(method_name), '').split('/').last
+      end
+
+      def method_source name
+        DurableDecorator::Base.extract_method(name).source_location[0]
+      end
+
+      def class_name method_name
+        method_name.match(receiver_separator)[1]
+      end
+
+      def class_location method_name
+        "/#{class_name(method_name).underscore}.rb"
+      end
+
+      def namespace method_name
+        namespace = method_name.match(receiver_separator)[1].split('::')[0..-2].join('/').underscore
+        namespace.presence
+      end
+
+      def receiver_separator
+        /(.*)(\.|#)(.*)/
+      end
+    end
+  end
+end

data/lib/durable_decorator_rails/version.rb

@@ -1,3 +1,3 @@
 module DurableDecoratorRails
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/generators/decorator/decorator_generator.rb

@@ -0,0 +1,93 @@
+class DecoratorGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :full_method_name, :type => :string
+
+  def ensure_decorator_existence
+    ensure_file
+    ensure_method
+  end
+
+private
+
+  def filesystem_parts
+    full_method_name.split('::')
+  end
+
+  def target
+    filesystem_parts.last
+  end
+
+  def parts
+    target.match(DurableDecoratorRails::ClassTypeExtractor.receiver_separator)[1..3]
+  end
+
+  def full_class_name
+    full_method_name.match(DurableDecoratorRails::ClassTypeExtractor.receiver_separator)[1]
+  end
+
+  def class_name
+    parts[0]
+  end
+
+  def method_name
+    parts[2]
+  end
+
+  def filename
+    "#{class_name.underscore}_decorator.rb"
+  end
+
+  def full_path
+    "#{DurableDecoratorRails::ClassTypeExtractor.decorator_path(full_method_name)}/#{filename}"
+  end
+
+  def ensure_file
+    template "decorator.rb.erb", full_path unless File.exists?(full_path)
+  end
+
+  def ensure_method
+    append_decoration unless method_decorated?
+  end
+
+  def append_decoration
+    inject_into_file full_path, after: "class_eval do" do
+      redefinition_template 
+    end
+  end
+
+  def redefinition_template
+    "  \n\n" +
+    redefinition_body +
+    "  \n" 
+  end
+
+  def redefinition_body
+    "  durably_decorate :#{method_name}, mode: 'strict', sha: '#{existing_sha}' do #{decoration_args}\n" +
+    "  end"
+  end
+
+  def existing_sha
+    DurableDecorator::Base.determine_sha full_method_name
+  end
+
+  def decoration_args
+    "|#{minimum_arity.times.map{|n| "arg#{n}"}.join(', ')}|" if minimum_arity > 0
+  end
+
+  def minimum_arity
+    arity = DurableDecorator::Base.determine_arity(full_method_name)
+    if arity < 0
+      (arity+1).abs
+    else
+      arity
+    end
+  end
+
+  def method_decorated? 
+    existing_contents.match /durably_decorate :#{method_name}/
+  end
+
+  def existing_contents
+    File.read(full_path)
+  end
+end

data/spec/class_type_extractor_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'example/app/models/example_model.rb'
+require 'example/lib/example_lib.rb'
+require 'example/lib/namespaced/and_again/example_lib.rb'
+
+describe DurableDecoratorRails::ClassTypeExtractor do
+  let(:singleton){ DurableDecoratorRails::ClassTypeExtractor }
+
+  context 'on .decorator_path' do
+    context 'when given the fully qualified method name' do
+      it 'returns the correct Rails decorator path' do
+        singleton.decorator_path("ExampleModel#methud").should == 'app/models'
+      end
+    end
+
+    context 'when given a namespaced file' do
+      it 'takes into account the namespace' do
+        singleton.decorator_path("Namespaced::AndAgain::ExampleLib.methud").should == 'lib/namespaced/and_again'
+      end
+    end
+  end
+
+  context 'on .determine_class_type' do
+    context 'when given the fully qualified method name' do
+      it 'returns the correct Rails class type' do
+        singleton.determine_class_type("ExampleModel.methud").should == 'models'
+        singleton.determine_class_type("ExampleModel#methud").should == 'models'
+        singleton.determine_class_type("ExampleLib#methud").should == 'lib'
+      end
+    end
+
+    context 'when given a namespaced file' do
+      it 'pulls through' do
+        singleton.determine_class_type("Namespaced::AndAgain::ExampleLib.methud").should == 'lib'
+      end
+    end
+  end
+end

data/spec/example/app/models/example_model.rb

@@ -0,0 +1,7 @@
+class ExampleModel
+  def methud
+  end
+
+  def self.methud
+  end
+end

data/spec/example/lib/example_lib.rb

@@ -0,0 +1,7 @@
+class ExampleLib
+  def methud
+  end
+
+  def self.methud
+  end
+end

data/spec/example/lib/namespaced/and_again/example_lib.rb

@@ -0,0 +1,11 @@
+module Namespaced
+  module AndAgain
+    class ExampleLib
+      def methud
+      end
+
+      def self.methud
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: durable_decorator_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Denis Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: durable_decorator
@@ -97,13 +97,17 @@ files:
 - Rakefile
 - durable_decorator_rails.gemspec
 - lib/durable_decorator_rails.rb
+- lib/durable_decorator_rails/class_type_extractor.rb
 - lib/durable_decorator_rails/durable_decorator_ext.rb
 - lib/durable_decorator_rails/railtie.rb
 - lib/durable_decorator_rails/version.rb
-- lib/generators/durable_decorator/decorator/decorator_generator.rb
-- lib/generators/durable_decorator/decorator/templates/decorator.rb.erb
+- lib/generators/decorator/decorator_generator.rb
+- lib/generators/decorator/templates/decorator.rb.erb
 - lib/tasks/durable_decorator_rails.tasks
-- spec/durable_decorator_rails_spec.rb
+- spec/class_type_extractor_spec.rb
+- spec/example/app/models/example_model.rb
+- spec/example/lib/example_lib.rb
+- spec/example/lib/namespaced/and_again/example_lib.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jumph4x/durable_decorator_rails
 licenses:
@@ -130,5 +134,8 @@ signing_key:
 specification_version: 4
 summary: Rails integration for durable_decorator
 test_files:
-- spec/durable_decorator_rails_spec.rb
+- spec/class_type_extractor_spec.rb
+- spec/example/app/models/example_model.rb
+- spec/example/lib/example_lib.rb
+- spec/example/lib/namespaced/and_again/example_lib.rb
 - spec/spec_helper.rb

data/lib/generators/durable_decorator/decorator/decorator_generator.rb

@@ -1,115 +0,0 @@
-module DurableDecorator
-  class DecoratorGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-    argument :subdirectory, :type => :string
-    argument :full_method_name, :type => :string
-
-    def ensure_decorator_existence
-      ensure_file
-      ensure_method
-    end
-
-  private
-
-    def namespaces
-      filesystem_parts[0..-2]
-    end
-
-    def parts
-      target.match(receiver_separator_regex)[1..3]
-    end
-
-    def receiver_separator_regex
-      /(.*)(\.|#)(.*)/
-    end
-
-    def target
-      filesystem_parts.last
-    end
-
-    def class_name
-      parts[0]
-    end
-
-    def full_class_name
-      full_method_name.match(receiver_separator_regex)[1]
-    end
-
-    def separator
-      parts[1]
-    end
-
-    def method_name
-      parts[2]
-    end
-
-    def namespace_dirs
-      namespaces.map(&:underscore)
-    end
-
-    def filename
-      "#{class_name.underscore}_decorator.rb"
-    end
-
-    def filesystem_parts
-      full_method_name.split('::')
-    end
-
-    def dir_structure
-      "app/#{subdirectory}/#{namespace_dirs.join('/')}"
-    end
-
-    def full_path
-      "#{dir_structure}/#{filename}"
-    end
-
-    def ensure_file
-      template "decorator.rb.erb", full_path unless File.exists?(full_path)
-    end
-
-    def ensure_method
-      append_decoration unless method_decorated?
-    end
-
-    def append_decoration
-      contents = File.read(full_path).sub("\n", redefinition_template)
-      File.open(full_path, 'wb') { |file| file.write(contents) }
-    end
-
-    def redefinition_template
-      "  \n\n" +
-      redefinition_body +
-      "  \n" 
-    end
-
-    def redefinition_body
-      "  durably_decorate :#{method_name}, mode: 'strict', sha: '#{existing_sha}' do #{decoration_args}\n" +
-      "  end"
-    end
-
-    def existing_sha
-      DurableDecorator::Base.determine_sha full_method_name
-    end
-
-    def decoration_args
-      "|#{minimum_arity.times.map{|n| "arg#{n}"}.join(', ')}|" if minimum_arity > 0
-    end
-
-    def minimum_arity
-      arity = DurableDecorator::Base.determine_arity(full_method_name)
-      if arity < 0
-        (arity+1).abs
-      else
-        arity
-      end
-    end
-
-    def method_decorated? 
-      existing_contents.match /durably_decorate :#{method_name}/
-    end
-
-    def existing_contents
-      File.read(full_path)
-    end
-  end
-end

data/spec/durable_decorator_rails_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe DurableDecoratorRails do
-  it 'should have a version number' do
-    DurableDecoratorRails::VERSION.should_not be_nil
-  end
-
-  it 'should do something useful' do
-    false.should be_true
-  end
-end