hexx 7.1.0 → 8.0.0

data/lib/hexx/name.rb

@@ -1,72 +1,148 @@
 # encoding: utf-8
-# require "extlib"
+require "extlib"
 
 module Hexx
 
+  # Decorates a string with conventional names
   class Name
 
-    # @!attribute [r] object
-    # The object to be named.
-    # @return [Object] the object.
-
-    # @!attribute [r] locale
-    # The locale to be used for naming.
-    # Equals <tt>I18n.locale</tt> by default.
-    # @return [Symbol] the locale.
+    # @!scope class
+    # @!method new(string)
+    # Constructs the parser object
+    #
+    # @example
+    #   Hexx::Name.new "MyGem::MyClass.methods.chain"
+    #
+    # @param  [#to_s] string
+    #   The string to be parsed
+    #
+    # @return [Hexx::Name]
+    def initialize(string)
+      @list = string.to_s.snake_case.gsub(/\:{2}|-/, "/").split(".")
+    end
 
-    attr_reader :object, :locale
+    # Returns the last part of the singular name
+    #
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.item
+    #   # => "panther_tiger"
+    #
+    # @return [String]
+    def item
+      @item ||= snakes.last.to_s.singular
+    end
 
-    # @note The class has a private constructor. Use {.for} method instead.
-    private_class_method :new
+    # Returns the last part of the plural name
+    #
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.items
+    #   # => "panther_tigers"
+    #
+    # @return [String]
+    def items
+      @items ||= item.plural
+    end
 
-    # @api hide
-    # The class instance initializer.
+    # Returns the dashes-delimited name
+    #
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.file
+    #   # => "cats-wildcats-jaguars-panther_tiger.bite"
     #
-    # @param  [Object] object The object to be named.
-    # @param  [Symbol] locale The locale to be used for naming.
-    # @return [Hexx::Name] the class instance.
-    def initialize(object, locale)
-      @object, @locale = object, locale
+    # @return [String]
+    def file
+      @file ||= [snakes.join("-"), method].compact.join(".")
     end
 
-    # @abstract
-    # Returns the name for the current {#object}.
+    # Returns the slash-delimited name
     #
-    # @return [String] the name.
-    def for
-      ""
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.path
+    #   # => "cats/wildcats/jaguars/panther_tiger/bite"
+    #
+    # @return [String]
+    def path
+      @path ||= [snakes.join("/"), method].compact.join(".")
     end
 
-    # Constructs the name for given object and locale.
+    # Returns the name as a full constant
+    #
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.type
+    #   # => "Cats::Wildcats::Jaguars::PantherTiger.bite"
     #
-    # @param  [Object] object The object to be named.
-    # @param  [Symbol, nil] locale (I18n.locale)
-    #   The locale to be used for naming.
-    # @return [String] the name.
-    def self.for(object, locale: I18n.locale)
-      new(object, locale).for
+    # @return [String]
+    def type
+      @type ||= [camels.join("::"), method].compact.join(".")
     end
 
-    # Translates the value in the current scope and locale.
+    # Returns the name as a last part of constant
+    #
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.const
+    #   # => "PantherTiger.bite"
     #
-    # @param  [Symbol, String] value The value to be translated.
-    # @param  [Hash] options ({}) The options for the translation.
-    # @return [String] The translation.
-    def t(value, options = {})
-      return value unless value.is_a? Symbol
-      I18n.t value, options.merge(locale: locale, scope: scope)
+    # @return [String]
+    def const
+      @const ||= [camels.last, method].compact.join(".")
     end
 
-    # The scope for object translation.
-    # @return [Array<String, Symbol>] the list of scopes.
-    def scope
-      @scope ||= %w(activemodel models) << object_name
+    # Returns the array of namespaces (module names) for the constant
+    #
+    # @example
+    #   source = "cats-wildcats/jaguars::PantherTiger.bite"
+    #   name = Hexx::Name.new(source)
+    #   name.namespaces
+    #   # => ["Cats", "Wildcats", "Jaguars"]
+    #
+    # @return [Array<String>]
+    def namespaces
+      @namespaces ||= camels[0..-2]
     end
 
     private
 
-    def object_name
-      self.class.name.underscore.gsub("::", "/")
+    # String of chained methods
+    #
+    # @return [String]
+    # @return [nil]
+    #   if source has no methods
+    #
+    # @api private
+    def method
+      @method ||= @list[1..-1] if @list.count > 1
+    end
+
+    # List of snake-cased parts of the constant
+    #
+    # @return [Array<String>]
+    #
+    # @api private
+    def snakes
+      @snakes ||= @list.first.to_s.split("/")
+    end
+
+    # List of camel-cased parts of the constant
+    #
+    # @return [Array<String>]
+    #
+    # @api private
+    def camels
+      @camels ||= snakes.map(&:camel_case)
     end
-  end
-end
+
+  end # class Name
+
+end # module Hexx

data/lib/hexx/version.rb

@@ -1,6 +1,7 @@
-# Namespace for the gem.
-module Hexx
+# encoding: utf-8
 
-  # Current release.
-  VERSION = "7.1.0"
-end
+module Hexx
+  # The semantic version of the module.
+  # @see http://semver.org/ Semantic versioning 2.0
+  VERSION = "8.0.0".freeze
+end # module Hexx

data/spec/fixtures/root/_.beta

@@ -0,0 +1 @@
+<%= 2 * 2 -%>

data/spec/fixtures/root/gamma.rb.erb

@@ -0,0 +1 @@
+<%= 2 * 2 -%>

data/spec/spec_helper.rb

@@ -1,11 +1,6 @@
-require "coveralls"
+# Loads the RSpec test suit.
+require "hexx-suit"
+Hexx::Suit.load_metrics_for(self)
 
-# Application root
-root = File.expand_path "../..", __FILE__
-
-# Support files and Rspec settings
-Dir[File.join(root, "spec/support/**/*.rb")].each { |file| require file }
-
-# Application files
-Coveralls.wear!
-require File.join(root, "lib/hexx.rb")
+# Loads the gem.
+require "hexx"

data/spec/tests/lib/generator_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+# See settings for :sandbox and :capture tags in `config/initializers` folder
+describe Hexx::Generator do
+
+  # source path is set to spec/fixtures
+  let(:fixtures) { ::File.expand_path "../../../fixtures", __FILE__ }
+  before { allow(described_class).to receive(:source_root).and_return fixtures }
+
+  describe ".new" do
+
+    it "constructs Thor::Group instance" do
+      expect(subject).to be_kind_of Thor::Group
+    end
+
+    it "constructs Thor::Actions instance" do
+      expect(subject).to be_kind_of Thor::Actions
+    end
+
+  end # describe .new
+
+  describe "##source_root" do
+
+    it "returns a source root" do
+      expect(subject.send :source_root)
+        .to eq described_class.send(:source_root)
+    end
+
+  end # describe ##source_root
+
+  describe "#copy_folder", :sandbox, :capture do
+
+    shared_examples "copying files" do
+
+      # target should be described in context
+
+      it "[copy file as is]" do
+        expect("#{ target }/subfolder/alfa.yml").to be_present_in_sandbox
+      end
+
+    end # examples
+
+    shared_examples "removing last .erb only" do
+
+      # target should be described in context
+
+      it "[removes last .erb]" do
+        expect("#{ target }/gamma.rb").to be_present_in_sandbox
+      end
+
+      it "[leaves previous .erb]" do
+        expect("#{ target }/delta.erb").to be_present_in_sandbox
+      end
+
+    end # examples
+
+    shared_examples "removing first underscores only" do
+
+      it "[removes first _]" do
+        expect("#{ target }/.beta").to be_present_in_sandbox
+      end
+
+      it "[leaves later _]" do
+        expect("#{ target }/_omega").to be_present_in_sandbox
+      end
+
+    end # examples
+
+    shared_examples "preprocessing ERB only" do
+
+      # target should be described in context
+
+      it "[preprocesses erb]" do
+        content = read_in_sandbox("#{ target }/gamma.rb")
+        expect(content).not_to include "<%= 2 * 2 -%>"
+        expect(content).to include "4"
+      end
+
+      it "[leaves non-erb]" do
+        content = read_in_sandbox("#{ target }/.beta")
+        expect(content).to include "<%= 2 * 2 -%>"
+        expect(content).not_to include "4"
+      end
+
+    end # examples
+
+    context "when the target isn't set" do
+
+      let(:target) { "root" }
+
+      before { try_in_sandbox { subject.send :copy_folder, "root" } }
+
+      it_behaves_like "copying files"
+      it_behaves_like "removing last .erb only"
+      it_behaves_like "removing first underscores only"
+      it_behaves_like "preprocessing ERB only"
+
+    end # context
+
+    context "with the target is set" do
+
+      let(:target) { "spec" }
+
+      before { try_in_sandbox { subject.send :copy_folder, "root", target } }
+
+      it_behaves_like "copying files"
+      it_behaves_like "removing last .erb only"
+      it_behaves_like "removing first underscores only"
+      it_behaves_like "preprocessing ERB only"
+
+    end # context
+
+  end # describe ##copy_folder
+
+  describe "#from_template", :sandbox, :capture do
+
+    let(:content) { subject.send :from_template, "root/_.beta" }
+
+    it "returns the ERB-preprocessed content of the template" do
+      expect(content).not_to include "<%= 2 * 2 -%>"
+      expect(content).to include "4"
+    end
+
+  end # describe ##from_template
+
+end # describe Hexx::Generator

data/spec/tests/lib/name_spec.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+describe Hexx::Name do
+
+  describe ".new" do
+
+    it "requires an argument" do
+      expect { described_class.new    }.to     raise_error
+      expect { described_class.new "" }.not_to raise_error
+      expect { described_class.new "", "" }.to raise_error
+    end
+
+  end # describe .new
+
+  let(:a) { described_class.new nil }
+  let(:b) { described_class.new "cats" }
+  let(:c) { described_class.new "cats.names" }
+  let(:d) { described_class.new "cats-wildcats/jaguars::PantherTiger" }
+  let(:e) { described_class.new "cats-wildcats/jaguars::PantherTigers" }
+  let(:f) { described_class.new "cats-wildcats/jaguars::PantherTiger.a.B.c" }
+
+  describe "#item" do
+
+    it "returns a proper value" do
+      expect(a.item).to eq ""
+      expect(b.item).to eq "cat"
+      expect(c.item).to eq "cat"
+      expect(d.item).to eq "panther_tiger"
+      expect(e.item).to eq "panther_tiger"
+      expect(f.item).to eq "panther_tiger"
+    end
+
+  end # describe #item
+
+  describe "#items" do
+
+    it "returns a proper value" do
+      expect(a.items).to eq ""
+      expect(b.items).to eq "cats"
+      expect(c.items).to eq "cats"
+      expect(d.items).to eq "panther_tigers"
+      expect(e.items).to eq "panther_tigers"
+      expect(f.items).to eq "panther_tigers"
+    end
+
+  end # describe #items
+
+  describe "#file" do
+
+    it "returns a proper value" do
+      expect(a.file).to eq ""
+      expect(b.file).to eq "cats"
+      expect(c.file).to eq "cats.names"
+      expect(d.file).to eq "cats-wildcats-jaguars-panther_tiger"
+      expect(e.file).to eq "cats-wildcats-jaguars-panther_tigers"
+      expect(f.file).to eq "cats-wildcats-jaguars-panther_tiger.a.b.c"
+    end
+
+  end # describe #file
+
+  describe "#path" do
+
+    it "returns a proper value" do
+      expect(a.path).to eq ""
+      expect(b.path).to eq "cats"
+      expect(c.path).to eq "cats.names"
+      expect(d.path).to eq "cats/wildcats/jaguars/panther_tiger"
+      expect(e.path).to eq "cats/wildcats/jaguars/panther_tigers"
+      expect(f.path).to eq "cats/wildcats/jaguars/panther_tiger.a.b.c"
+    end
+
+  end # describe #path
+
+  describe "#type" do
+
+    it "returns a proper value" do
+      expect(a.type).to eq ""
+      expect(b.type).to eq "Cats"
+      expect(c.type).to eq "Cats.names"
+      expect(d.type).to eq "Cats::Wildcats::Jaguars::PantherTiger"
+      expect(e.type).to eq "Cats::Wildcats::Jaguars::PantherTigers"
+      expect(f.type).to eq "Cats::Wildcats::Jaguars::PantherTiger.a.b.c"
+    end
+
+  end # describe #type
+
+  describe "#const" do
+
+    it "returns a proper value" do
+      expect(a.const).to eq ""
+      expect(b.const).to eq "Cats"
+      expect(c.const).to eq "Cats.names"
+      expect(d.const).to eq "PantherTiger"
+      expect(e.const).to eq "PantherTigers"
+      expect(f.const).to eq "PantherTiger.a.b.c"
+    end
+
+  end # describe #const
+
+  describe "#namespaces" do
+
+    it "returns a proper value" do
+      expect(a.namespaces).to eq %w()
+      expect(b.namespaces).to eq %w()
+      expect(c.namespaces).to eq %w()
+      expect(d.namespaces).to eq %w(Cats Wildcats Jaguars)
+      expect(e.namespaces).to eq %w(Cats Wildcats Jaguars)
+      expect(f.namespaces).to eq %w(Cats Wildcats Jaguars)
+    end
+
+  end # describe #namespaces
+
+end # describe Hexx::Name