eman 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d47a00fe58b4d96d4dabeb13a427f912d554239
+  data.tar.gz: 08ffc135a0e4d33a20bc6bb836664323b8d56d97
+SHA512:
+  metadata.gz: ee1b7507e854d0f04676742aaa9628e57be9bcc17d570cd39acfe795619fd40c1ff0190232f646a81a2375f8b5eb71740156b69790feb32503f906f6ea4f704f
+  data.tar.gz: 476c2d48c7966269715ff3032a6cc8c22fb5903c0e1dfe7e701556be2eab012d126eeaa1a5b240071fbe535b07ecd0e063afbc639567f2fe4e6b7e1b6cc3fca8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eman.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sung Won Cho
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Eman
+
+Easily name your controller, model, and service. Let Eman recommend you good names.
+
+## Why?
+
+Well named files help your codebase to become more maintainable in the long run.
+
+## Installation
+
+Install the gem:
+
+    $ gem install eman
+
+
+## Usage
+
+Simply run the following commands as you see fit:
+
+    $ emac controller
+    $ emac model
+    $ emac service
+
+## Contributing
+
+### Recommendation system
+
+Help us improve our recommendation system. Simply add new, relevant words in the dictionary YAML files.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/eman

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "eman"
+
+module Eman
+  class CLI < Thor
+
+    desc "controller", "name a controller"
+    def controller
+      generator = Eman::NameGenerator.new('Controller')
+      generator.run
+    end
+
+    desc "service", "name a service"
+    def service
+      generator = Eman::NameGenerator.new('Service')
+      generator.run
+    end
+
+    desc "model", "name a model"
+    def model
+      generator = Eman::NameGenerator.new('Model')
+      generator.run
+    end
+
+  end
+end
+
+Eman::CLI.start(ARGV)

data/eman.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eman"
+  spec.version       = Eman::VERSION
+  spec.authors       = ["Sung Won Cho"]
+  spec.email         = ["mikeswcho@gmail.com"]
+  spec.summary       = %q{Easily name your controller, model, and service.}
+  spec.description   = %q{Easily name your controller, model, and service, with some further recommendations.}
+  spec.homepage      = "https://github.com/sungwoncho/eman"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
+end

data/lib/eman/name_formatter.rb

@@ -0,0 +1,52 @@
+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/lib/eman/name_generator.rb

@@ -0,0 +1,41 @@
+module Eman
+  class NameGenerator
+
+    attr_accessor :resource, :verb, :name
+    attr_reader :type
+
+    def initialize(type)
+      @type = type
+      @resource = ''
+      @verb = ''
+      @name = ''
+    end
+
+    def run
+      ask_resource
+      ask_verb if type == 'Service'
+      generate_name
+      print_name
+    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
+      end
+
+      def ask_verb
+        puts "What is the primary action you are performing on '#{resource}'?"
+        @verb = $stdin.gets.chomp
+      end
+
+      def generate_name
+        @name = ::Eman::NameFormatter.new(@resource, @verb, @type).camel_case!
+      end
+
+      def print_name
+        puts "#{type} name : '#{name}'"
+      end
+  end
+end

data/lib/eman/version.rb

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

data/lib/eman.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path('../eman', __FILE__)
+
+require "version"
+
+module Eman
+  autoload :NameGenerator, 'name_generator'
+  autoload :NameFormatter, 'name_formatter'
+end

data/spec/eman_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe Eman do
+  it { should be_a(Module) }
+end

data/spec/name_formatter_spec.rb

@@ -0,0 +1,56 @@
+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

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

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# Require all files under /lib
+Dir[File.expand_path('../../lib/**/*.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
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: eman
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sung Won Cho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily name your controller, model, and service, with some further recommendations.
+email:
+- mikeswcho@gmail.com
+executables:
+- eman
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/eman
+- eman.gemspec
+- lib/eman.rb
+- lib/eman/name_formatter.rb
+- lib/eman/name_generator.rb
+- lib/eman/version.rb
+- spec/eman_spec.rb
+- spec/name_formatter_spec.rb
+- spec/name_generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sungwoncho/eman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Easily name your controller, model, and service.
+test_files:
+- spec/eman_spec.rb
+- spec/name_formatter_spec.rb
+- spec/name_generator_spec.rb
+- spec/spec_helper.rb