eman 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d47a00fe58b4d96d4dabeb13a427f912d554239
-  data.tar.gz: 08ffc135a0e4d33a20bc6bb836664323b8d56d97
+  metadata.gz: 98d11c7b517bdbe6a7f443288f62802865f25e35
+  data.tar.gz: 896d98abfd84544711e47d89a924fe902cc2bf42
 SHA512:
-  metadata.gz: ee1b7507e854d0f04676742aaa9628e57be9bcc17d570cd39acfe795619fd40c1ff0190232f646a81a2375f8b5eb71740156b69790feb32503f906f6ea4f704f
-  data.tar.gz: 476c2d48c7966269715ff3032a6cc8c22fb5903c0e1dfe7e701556be2eab012d126eeaa1a5b240071fbe535b07ecd0e063afbc639567f2fe4e6b7e1b6cc3fca8
+  metadata.gz: 48d48ebd57d664440421020381d9635f521e0d2e223c38066ab33c4a3369fa77465da9e3bae7762b4f6ebf0187bd90614a75367d01e13efdb2ebef0d7106c701
+  data.tar.gz: 1c174d36e6fd8f8cf2586c6ef989f940ac16c8951bff3a6f55edd62cfa03c7e64d08cb244833cdc8248ec284f5f7fa68baf5e93ef28fbe9946ea0d93c6a5a29d

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.2.0

data/README.md

@@ -1,5 +1,8 @@
 # Eman
 
+[![Build Status](https://travis-ci.org/sungwoncho/eman.svg?branch=master)](https://travis-ci.org/sungwoncho/eman)
+[![Code Climate](https://codeclimate.com/github/sungwoncho/eman/badges/gpa.svg)](https://codeclimate.com/github/sungwoncho/eman)
+
 Easily name your controller, model, and service. Let Eman recommend you good names.
 
 ## Why?
@@ -21,8 +24,10 @@ Simply run the following commands as you see fit:
     $ emac model
     $ emac service
 
+Eman will ask you a question or two, and spit out a name, with a further recommendation.
+
 ## Contributing
 
 ### Recommendation system
 
-Help us improve our recommendation system. Simply add new, relevant words in the dictionary YAML files.
+Help us improve our recommendation system by adding new entries in the internal dictionary. See [this wiki](https://github.com/sungwoncho/eman/wiki/Internal-Dictionary) for more information.

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
 
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: :spec

data/bin/eman

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 require "thor"
 require "eman"
 
@@ -8,19 +6,19 @@ module Eman
 
     desc "controller", "name a controller"
     def controller
-      generator = Eman::NameGenerator.new('Controller')
+      generator = Eman::Generator.new('Controller')
       generator.run
     end
 
     desc "service", "name a service"
     def service
-      generator = Eman::NameGenerator.new('Service')
+      generator = Eman::Generator.new('Service')
       generator.run
     end
 
     desc "model", "name a model"
     def model
-      generator = Eman::NameGenerator.new('Model')
+      generator = Eman::Generator.new('Model')
       generator.run
     end
 

data/lib/eman.rb

@@ -3,6 +3,8 @@ $:.unshift File.expand_path('../eman', __FILE__)
 require "version"
 
 module Eman
-  autoload :NameGenerator, 'name_generator'
-  autoload :NameFormatter, 'name_formatter'
+  autoload :Generator, 'generator'
+  autoload :Formatter, 'formatter'
+  autoload :Recommender, 'recommender'
+  autoload :Dictionary, 'dictionary'
 end

data/lib/eman/dictionary.rb

@@ -0,0 +1,27 @@
+require "yaml"
+
+module Eman
+  class Dictionary
+
+    INDICES_FILE = File.expand_path('../dictionary/indices.yml', __FILE__)
+    WORDS_FILE = File.expand_path('../dictionary/words.yml', __FILE__)
+
+    def self.find_similar(word)
+      index = fetch_index(word)
+      fetch_words(index)
+    end
+
+    private
+
+      def self.fetch_index(key)
+        indices = YAML.load_file(INDICES_FILE)
+        indices[key]
+      end
+
+      def self.fetch_words(index)
+        words_list = YAML.load_file(WORDS_FILE)
+        words_list[index] || []
+      end
+
+  end
+end

data/lib/eman/dictionary/indices.yml

@@ -0,0 +1,21 @@
+acquisition: 5
+benchmark: 2
+buy: 5
+buyer: 1
+booking: 4
+calculate: 2
+chat: 3
+count: 2
+convesation: 3
+customer: 1
+client: 1
+enrollment: 4
+measure: 2
+message: 3
+notification: 3
+registration: 4
+post: 6
+purchase: 5
+shopping: 5
+thread: 6
+user: 1

data/lib/eman/dictionary/words.yml

@@ -0,0 +1,6 @@
+1: ['user', 'customer', 'client', 'buyer']
+2: ['measure', 'benchmark', 'calculate', 'count']
+3: ['message', 'conversation', 'notification', 'chat']
+4: ['registration', 'enrollment', 'booking']
+5: ['purchase', 'buy', 'acquisition', 'shopping']
+6: ['post', 'thread']

data/lib/eman/formatter.rb

@@ -0,0 +1,48 @@
+require "active_support/inflector"
+
+module Eman
+  class Formatter
+
+    def initialize(generator)
+      @generator = generator
+    end
+
+    def camel_case!
+      if is_model_name?
+        "#{inputs_camelized}"
+      else
+        "#{inputs_camelized}#{type.capitalize}"
+      end
+    end
+
+    def snake_case!
+      if is_model_name?
+        "#{inputs_snakified}"
+      else
+        "#{inputs_snakified}_#{type.downcase}"
+      end
+    end
+
+    private
+
+      def inputs
+        @generator.inputs
+      end
+
+      def type
+        @generator.type
+      end
+
+      def inputs_camelized
+        inputs.collect(&:capitalize).join
+      end
+
+      def inputs_snakified
+        inputs.collect(&:downcase).join('_')
+      end
+
+      def is_model_name?
+        type == 'Model'
+      end
+  end
+end

data/lib/eman/{name_generator.rb → generator.rb}

@@ -1,14 +1,11 @@
 module Eman
-  class NameGenerator
+  class Generator
 
-    attr_accessor :resource, :verb, :name
+    attr_accessor :resource, :verb, :name, :recommended_name
     attr_reader :type
 
     def initialize(type)
       @type = type
-      @resource = ''
-      @verb = ''
-      @name = ''
     end
 
     def run
@@ -18,24 +15,30 @@ module Eman
       print_name
     end
 
+    def inputs
+      [resource, verb].compact.flat_map(&:split)
+    end
+
     private
 
       def ask_resource
         puts "What is the resource that you are dealing with? (e.g. User, Session, Order, etc.)"
-        @resource = $stdin.gets.chomp
+        @resource = $stdin.gets.chomp.downcase
       end
 
       def ask_verb
         puts "What is the primary action you are performing on '#{resource}'?"
-        @verb = $stdin.gets.chomp
+        @verb = $stdin.gets.chomp.downcase
       end
 
       def generate_name
-        @name = ::Eman::NameFormatter.new(@resource, @verb, @type).camel_case!
+        @name = Eman::Formatter.new(self).camel_case!
+        @recommended_name = Eman::Recommender.new(self).recommend_name
       end
 
       def print_name
         puts "#{type} name : '#{name}'"
+        puts "Further suggestion: '#{recommended_name}'" if recommended_name
       end
   end
 end

data/lib/eman/recommender.rb

@@ -0,0 +1,56 @@
+module Eman
+  class Recommender
+
+    attr_reader :generator
+
+    def initialize(generator)
+      @generator = generator
+    end
+
+    def inputs
+      @inputs ||= @generator.inputs
+    end
+
+    def type
+      @type ||= @generator.type
+    end
+
+    def words_hash
+      @words_hash ||= Hash[ inputs.collect { |x| [x, []] } ]
+    end
+
+    def recommend_name
+      fetch_similar_words
+      assemble_words
+    end
+
+    private
+
+      def fetch_similar_words
+        inputs.each do |i|
+          synonyms = Dictionary.find_similar(i)
+
+          synonyms.each { |s| words_hash[i] << s } if synonyms.any?
+        end
+      end
+
+      def assemble_words
+        recommended_name = []
+
+        if words_hash.values.flatten.length != inputs.length
+
+          words_hash.each do |key, val|
+            recommended_name << val.sample
+          end
+
+          if recommended_name.any?
+            recommended = Eman::Generator.new(type)
+            recommended.resource = recommended_name.join(' ')
+
+            recommended
+          end
+
+        end
+      end
+  end
+end

data/lib/eman/version.rb

@@ -1,3 +1,3 @@
 module Eman
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/dictionary_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+RSpec.describe Eman::Dictionary do
+
+  describe '.find_similar' do
+    it 'returns an array of similar words' do
+      set_up_custom_dictionary
+
+      array = Eman::Dictionary.find_similar('user')
+      expect(array).to eq ['user', 'customer']
+    end
+  end
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+RSpec.describe Eman::Formatter do
+
+  describe '#camel_case!' do
+    it 'outsputs a camel cased name' do
+      generator = Eman::Generator.new('Service')
+      generator.resource = 'Cheese Cake'
+      generator.verb = 'Grinding'
+      formatter = Eman::Formatter.new(generator)
+      outcome = formatter.camel_case!
+
+      expect(outcome).to eq 'CheeseCakeGrindingService'
+    end
+
+    context 'when type is model' do
+      it 'does not append the type at the end' do
+        generator = Eman::Generator.new('Model')
+        generator.resource = 'Shopping Cart'
+        formatter = Eman::Formatter.new(generator)
+        outcome = formatter.camel_case!
+
+        expect(outcome).to eq 'ShoppingCart'
+      end
+    end
+  end
+
+  describe '#snake_case!' do
+    it 'outputs a snake cased name' do
+      generator = Eman::Generator.new('Service')
+      generator.resource = 'Cheese Cake'
+      generator.verb = 'Grinding'
+      formatter = Eman::Formatter.new(generator)
+      outcome = formatter.snake_case!
+
+      expect(outcome).to eq 'cheese_cake_grinding_service'
+    end
+
+    context 'when type is model' do
+      it 'does not append the type at the end' do
+        generator = Eman::Generator.new('Model')
+        generator.resource = 'Shopping Cart'
+        formatter = Eman::Formatter.new(generator)
+        outcome = formatter.snake_case!
+
+        expect(outcome).to eq 'shopping_cart'
+      end
+    end
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+RSpec.describe Eman::Generator do
+  describe '#run' do
+    context 'when type is service' do
+      it 'should ask two questions' do
+        generator = Eman::Generator.new('Service')
+        allow($stdin).to receive(:gets) { 'Measure' }
+
+        expect($stdin).to receive(:gets).twice
+        generator.run
+      end
+    end
+
+    context 'when type is not service' do
+      it 'should ask one question' do
+        generator = Eman::Generator.new('Controller')
+        allow($stdin).to receive(:gets) { 'User' }
+
+        expect($stdin).to receive(:gets).once
+        generator.run
+      end
+    end
+  end
+
+  describe '#inputs' do
+    it 'returns a flat array splited at spaces' do
+      generator = Eman::Generator.new('Service')
+      generator.resource = 'Alarm clock'
+      generator.verb = 'reset'
+
+      expect(generator.inputs).to eq ['Alarm', 'clock', 'reset']
+    end
+  end
+end

data/spec/recommender_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+RSpec.describe Eman::Recommender do
+
+  before(:each) do
+    @generator = Eman::Generator.new('Service')
+    @generator.resource = 'Train Conductor'
+    @generator.verb = 'Whistling'
+
+    @formatter = Eman::Recommender.new(@generator)
+  end
+
+  describe '#inputs' do
+    it 'returns the generators inputs' do
+      expect(@formatter.inputs).to eq ['Train', 'Conductor', 'Whistling']
+    end
+  end
+
+  describe '#words_hash' do
+    it 'returns hash of words as keys and empty arrays as values' do
+      expect(@formatter.words_hash).to eq({ 'Train' => [], 'Conductor' => [], 'Whistling' => [] })
+    end
+  end
+
+  describe '#recommend_name' do
+    it 'recommends a name' do
+      set_up_custom_dictionary
+
+      generator = Eman::Generator.new('Controller')
+      generator.resource = 'deep'
+
+      recommender = Eman::Recommender.new(generator)
+
+      puts recommender.words_hash
+
+      recommended_name = recommender.recommend_name
+
+      puts recommender.words_hash
+      expect(recommended_name.resource).to eq 'house'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 # Require all files under /lib
 Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each { |f| require f }
 
+# Require all support files
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
@@ -43,6 +46,8 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  config.include DictionaryMacros
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

data/spec/support/dictionary/indices.yml

@@ -0,0 +1,3 @@
+user: 1
+customer: 1
+deep: 2

data/spec/support/dictionary/words.yml

@@ -0,0 +1,2 @@
+1: ['user', 'customer']
+2: ['house', 'house']

data/spec/support/dictionary_macros.rb

@@ -0,0 +1,11 @@
+module DictionaryMacros
+  def set_up_custom_dictionary
+    # Custom dictionary files defined in spec/support/dictionary
+    indices_file = YAML.load_file(File.expand_path('../dictionary/indices.yml', __FILE__))
+    words_file = YAML.load_file(File.expand_path('../dictionary/words.yml', __FILE__))
+
+    # Use a custom dictionary files for tests.
+    allow(YAML).to receive(:load_file).with(File.expand_path('../../../lib/eman/dictionary/indices.yml', __FILE__)).and_return(indices_file)
+    allow(YAML).to receive(:load_file).with(File.expand_path('../../../lib/eman/dictionary/words.yml', __FILE__)).and_return(words_file)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eman
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sung Won Cho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,13 +98,22 @@ files:
 - bin/eman
 - eman.gemspec
 - lib/eman.rb
-- lib/eman/name_formatter.rb
-- lib/eman/name_generator.rb
+- lib/eman/dictionary.rb
+- lib/eman/dictionary/indices.yml
+- lib/eman/dictionary/words.yml
+- lib/eman/formatter.rb
+- lib/eman/generator.rb
+- lib/eman/recommender.rb
 - lib/eman/version.rb
+- spec/dictionary_spec.rb
 - spec/eman_spec.rb
-- spec/name_formatter_spec.rb
-- spec/name_generator_spec.rb
+- spec/formatter_spec.rb
+- spec/generator_spec.rb
+- spec/recommender_spec.rb
 - spec/spec_helper.rb
+- spec/support/dictionary/indices.yml
+- spec/support/dictionary/words.yml
+- spec/support/dictionary_macros.rb
 homepage: https://github.com/sungwoncho/eman
 licenses:
 - MIT
@@ -129,7 +139,12 @@ signing_key:
 specification_version: 4
 summary: Easily name your controller, model, and service.
 test_files:
+- spec/dictionary_spec.rb
 - spec/eman_spec.rb
-- spec/name_formatter_spec.rb
-- spec/name_generator_spec.rb
+- spec/formatter_spec.rb
+- spec/generator_spec.rb
+- spec/recommender_spec.rb
 - spec/spec_helper.rb
+- spec/support/dictionary/indices.yml
+- spec/support/dictionary/words.yml
+- spec/support/dictionary_macros.rb

data/lib/eman/name_formatter.rb

@@ -1,52 +0,0 @@
-require "active_support/inflector"
-
-module Eman
-  class NameFormatter
-
-    attr_accessor :type, :resource, :verb
-
-    def initialize(resource, verb, type)
-      @type = type
-      @resource = is_controller_name? ? resource.pluralize : resource
-      @verb = verb
-    end
-
-    def camel_case!
-      if is_model_name?
-        "#{components_camelized}"
-      else
-        "#{components_camelized}#{type.capitalize}"
-      end
-    end
-
-    def snake_case!
-      if is_model_name?
-        "#{components_snakified}"
-      else
-        "#{components_snakified}_#{type.downcase}"
-      end
-    end
-
-    private
-
-      def components
-        [resource, verb].flat_map(&:split)
-      end
-
-      def components_camelized
-        components.collect(&:capitalize).join
-      end
-
-      def components_snakified
-        components.collect(&:downcase).join('_')
-      end
-
-      def is_controller_name?
-        type == 'Controller'
-      end
-
-      def is_model_name?
-        type == 'Model'
-      end
-  end
-end

data/spec/name_formatter_spec.rb

@@ -1,56 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Eman::NameFormatter do
-
-  describe '#initialize' do
-    context 'when type is controller' do
-      it 'pluralizes the resource' do
-        formatter = Eman::NameFormatter.new('Alarm clock', 'Operating', 'Controller')
-        expect(formatter.resource).to eq 'Alarm clocks'
-      end
-    end
-
-    context 'when type is not controller' do
-      it 'does not pluralize the resource' do
-        formatter = Eman::NameFormatter.new('Alarm clock', 'Operating', 'Service')
-        expect(formatter.resource).to eq 'Alarm clock'
-      end
-    end
-  end
-
-  describe '#camel_case!' do
-    it 'outsputs a camel cased name' do
-      formatter = Eman::NameFormatter.new('cheese', 'grinding', 'Service')
-      outcome = formatter.camel_case!
-
-      expect(outcome).to eq 'CheeseGrindingService'
-    end
-
-    context 'when type is model' do
-      it 'does not append the type at the end' do
-        formatter = Eman::NameFormatter.new('Shopping', 'Cart', 'Model')
-        outcome = formatter.camel_case!
-
-        expect(outcome).to eq 'ShoppingCart'
-      end
-    end
-  end
-
-  describe '#snake_case!' do
-    it 'outputs a snake cased name' do
-      formatter = Eman::NameFormatter.new('guitar', 'smashing', 'Service')
-      outcome = formatter.snake_case!
-
-      expect(outcome).to eq 'guitar_smashing_service'
-    end
-
-    context 'when type is model' do
-      it 'does not append the type at the end' do
-        formatter = Eman::NameFormatter.new('Shopping', 'Cart', 'Model')
-        outcome = formatter.snake_case!
-
-        expect(outcome).to eq 'shopping_cart'
-      end
-    end
-  end
-end

data/spec/name_generator_spec.rb

@@ -1,5 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Eman::NameGenerator do
-  
-end