hoygancop 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@hoygan --create

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dexter.gemspec
+gemspec
+
+group :test do
+  gem 'guard'
+  gem 'guard-minitest'
+  gem 'minitest-reporters'
+end
+
+group :darwin do
+  gem 'rb-fsevent'
+  gem 'growl'
+  gem 'guard-bundler'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  watch(/^.+.gemspec/)
+end

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task default: [:test]

data/Readme.md

@@ -0,0 +1,55 @@
+# hoygancop
+
+A gem meant to detect and correct Hoygans.
+
+For a definition of Hoygan (spanish): http://www.frikipedia.es/friki/HOYGAN
+
+# Install
+
+In your Gemfile:
+
+    gem 'hoygancop'
+
+# Usage
+
+    require 'hoygancop'
+
+## Hoygan detection
+
+For simple detection of Hoygans:
+
+    Hoygancop.hoygan?("HOYGAN AYUDENME TENGO UN PROBLEMA POR FAVOR?????")
+    # => true
+
+For correcting Hoygans:
+
+    Hoygancop.correct("HOYGAN TENGO UN PROBLEMA AYUDENME!!!!!!!!!!")
+    # => 'Perdonen tengo un problema ¿me podrían ayudar?'
+
+For the full report of Hoygan reasons:
+
+    Hoygancop.report("HOYGAN TENGO UN PROBLEMA AYUDENME!!!!!!!!!!")
+    # => [:starts_with_hoygan, :ayudenme, :too_much_marks, :too_much_caps]
+
+# TODO
+
+* Write a hoygan_validations gem for easy Rails 3 integration
+* Extend with more hoygan rules
+* World domination
+
+# Just for the lulz
+
+* Write a Twitter bot (heck yes, I registered @hoygancop)
+* Create a REST service for easy hoygan detection
+
+# Contributions
+
+You can run the test suite with the default rake task:
+
+    bundle exec rake
+
+You can extend hoygancop with more rules easily. Just take a look at `lib/hoygancop/rules`
+
+# Contributors
+
+* @josepjaume

data/hoygan.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hoygancop/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hoygancop"
+  s.version     = Hoygancop::VERSION
+  s.authors     = ["Josep Jaume Rey"]
+  s.email       = ["josepjaume@gmail.com"]
+  s.homepage    = "http://github.com/scumbag/hoygan"
+  s.summary     = %q{A gem for easy detection and correction of hoygans}
+  s.description = %q{A gem for easy detection and correction of hoygans}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+end

data/lib/hoygancop.rb

@@ -0,0 +1,32 @@
+require "hoygancop/version"
+require 'hoygancop/rules'
+require 'hoygancop/support'
+
+module Hoygancop
+  def self.default_rules
+    %w{starts_with_hoygan ayudenme too_much_marks too_much_caps}
+  end
+
+  def self.ruleset(rules)
+    rules.map do |rule|
+      Hoygancop::Rules.const_get(Hoygancop::Support.camelize(rule).to_sym)
+    end
+  end
+
+  def self.hoygan?(text, options = {})
+    rules = (options[:rules] || default_rules)
+    ruleset(rules).any?{ |rule| rule.new(text).hoygan? }
+  end
+
+  def self.correct(text, options = {})
+    rules = (options[:rules] || default_rules)
+    ruleset(rules).inject(text){ |text, rule| rule.new(text).correct }
+  end
+
+  def self.report(text, options = {})
+    rules = (options[:rules] || default_rules)
+    ruleset(rules).inject(Set.new) do |report, rule|
+      report + rule.new(text).report
+    end.to_a
+  end
+end

data/lib/hoygancop/rules.rb

@@ -0,0 +1,4 @@
+require 'hoygancop/rules/starts_with_hoygan'
+require 'hoygancop/rules/too_much_marks'
+require 'hoygancop/rules/too_much_caps'
+require 'hoygancop/rules/ayudenme'

data/lib/hoygancop/rules/ayudenme.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require_relative 'simple_rule'
+
+module Hoygancop
+  module Rules
+    class Ayudenme
+      include SimpleRule
+
+      def correct
+        @text.gsub(/ayudenme/i, "¿me podrían ayudar?")
+      end
+    end
+  end
+end

data/lib/hoygancop/rules/simple_rule.rb

@@ -0,0 +1,20 @@
+require 'hoygancop/support'
+
+module Hoygancop
+  module Rules
+    module SimpleRule
+      def initialize(text)
+        @text = text
+      end
+
+      def hoygan?
+        @text != correct
+      end
+
+      def report
+        class_name = Hoygancop::Support.demodulize self.class.name
+        [Hoygancop::Support.underscore(class_name).to_sym] if hoygan? || []
+      end
+    end
+  end
+end

data/lib/hoygancop/rules/starts_with_hoygan.rb

@@ -0,0 +1,13 @@
+require_relative 'simple_rule'
+
+module Hoygancop
+  module Rules
+    class StartsWithHoygan
+      include SimpleRule
+
+      def correct
+        @text.gsub(/^Hoygan/i, "Perdonen")
+      end
+    end
+  end
+end

data/lib/hoygancop/rules/too_much_caps.rb

@@ -0,0 +1,34 @@
+require_relative 'simple_rule'
+
+module Hoygancop
+  module Rules
+    class TooMuchCaps
+      def initialize(text)
+        @text = text
+      end
+
+      def hoygan?
+        @text.scan(/[A-Z]/).length > @text.length/2
+      end
+
+      def correct
+        text = capitalize(@text, '.')
+        text = capitalize(text, '?')
+        text = capitalize(text, '!')
+      end
+
+      def report
+        [:too_much_caps] if hoygan? || []
+      end
+
+      private
+
+      def capitalize(text, separator)
+        text.split(separator).map do |sentence|
+          sentence.strip.capitalize
+        end.join(separator)
+      end
+
+    end
+  end
+end

data/lib/hoygancop/rules/too_much_marks.rb

@@ -0,0 +1,14 @@
+require_relative 'simple_rule'
+
+module Hoygancop
+  module Rules
+    class TooMuchMarks
+      include SimpleRule
+
+      def correct
+        corrected = @text.gsub(/[!]{1,}/i, "!").gsub(/[?]{3,}/i, "!")
+        corrected
+      end
+    end
+  end
+end

data/lib/hoygancop/support.rb

@@ -0,0 +1,63 @@
+module Hoygancop
+  # A module to offer helpers for string mangling.
+  #
+  module Support
+    # @param [String] name
+    #   The name to camelize.
+    #
+    # @return [String]
+    #   The +name+ in camel case.
+    #
+    # @example
+    #   Spinach::Support.camelize('User authentication')
+    #   => 'UserAuthentication'
+    #
+    # @api public
+    def self.camelize(name)
+      name.to_s.strip.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
+    end
+
+    # Makes an underscored, lowercase form from the expression in the string.
+    #
+    # Changes '::' to '/' to convert namespaces to paths.
+    #
+    # Examples:
+    #   "ActiveRecord".underscore         # => "active_record"
+    #   "ActiveRecord::Errors".underscore # => active_record/errors
+    #
+    # As a rule of thumb you can think of +underscore+ as the inverse of +camelize+,
+    # though there are cases where that does not hold:
+    #
+    #   "SSLError".underscore.camelize # => "SslError"
+    def self.underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    def self.demodulize(string_with_modules)
+      string_with_modules.split('::').pop
+    end
+
+    # Escapes the single commas of a given text. Mostly used in the {Generators}
+    # classes
+    #
+    # @param [String] text
+    #   The text to escape
+    #
+    # @return [String]
+    #   The +text+ with escaped commas
+    #
+    # @example
+    #   Spinach::Support.escape_single_commas("I've been bad")
+    #   # => "I\'ve been bad"
+    #
+    def self.escape_single_commas(text)
+      text.gsub("'", "\\\\'")
+    end
+  end
+end

data/lib/hoygancop/version.rb

@@ -0,0 +1,3 @@
+module Hoygancop
+  VERSION = "0.0.1"
+end

data/spec/hoygancop/rules/ayudenme_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require_relative '../../spec_helper'
+require 'hoygancop/rules/ayudenme'
+
+describe Hoygancop::Rules::Ayudenme do
+  subject{ Hoygancop::Rules::Ayudenme}
+  let(:hoygan) {"ayudenme tengo un problema" }
+  let(:correct) { "¿me podrían ayudar? tengo un problema" }
+  let(:report) { [:ayudenme] }
+  include RuleMatcher
+end

data/spec/hoygancop/rules/simple_rule_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require_relative '../../spec_helper'
+require 'hoygancop/rules/simple_rule'
+
+describe Hoygancop::Rules::SimpleRule do
+  let(:text){ "Hoygan ayudenme" }
+  subject{
+    Class.new do
+      include Hoygancop::Rules::SimpleRule
+    end.new(text)
+  }
+  describe "#hoygan?" do
+    it "returns true when corrected text is different" do
+      subject.stubs(correct: "Perdonen, ayudenme")
+      subject.hoygan?.must_equal true
+    end
+
+    it "returns false if corrected text is the same" do
+      subject.stubs(correct: text)
+      subject.hoygan?.must_equal false
+    end
+  end
+end

data/spec/hoygancop/rules/starts_with_hoygan_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require_relative '../../spec_helper'
+require 'hoygancop/rules/starts_with_hoygan'
+
+describe Hoygancop::Rules::StartsWithHoygan do
+  subject{ Hoygancop::Rules::StartsWithHoygan}
+  let(:hoygan) {"Hoygan ayudenme" }
+  let(:correct) { "Perdonen, ayudenme" }
+  let(:report) { [:starts_with_hoygan] }
+  include RuleMatcher
+end

data/spec/hoygancop/rules/too_much_caps_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require_relative '../../spec_helper'
+require 'hoygancop/rules/too_much_caps'
+
+describe Hoygancop::Rules::TooMuchCaps do
+  subject{ Hoygancop::Rules::TooMuchCaps}
+  let(:report) { [:too_much_caps] }
+
+  describe "with a single sentence" do
+    let(:hoygan) {"HOLA" }
+    let(:correct) { "Hola" }
+    include RuleMatcher
+  end
+
+  describe "with multiple sentences" do
+    let(:hoygan) {"MI AMIGO TIENE UN PROBLEMA. PUEDEN AYUDARME????" }
+    let(:correct) { "Mi amigo tiene un problema. Pueden ayudarme????" }
+    include RuleMatcher
+  end
+
+end

data/spec/hoygancop/rules/too_much_marks_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require_relative '../../spec_helper'
+require 'hoygancop/rules/too_much_marks'
+
+describe Hoygancop::Rules::TooMuchMarks do
+  subject{ Hoygancop::Rules::TooMuchMarks}
+  let(:report) { [:too_much_marks] }
+
+  describe "exclamation marks" do
+    let(:hoygan) {"Hola!!!!!!!" }
+    let(:correct) { "Hola!" }
+    include RuleMatcher
+  end
+
+  describe "question marks" do
+    let(:hoygan) {"Hola????" }
+    let(:correct) { "Hola?" }
+    include RuleMatcher
+  end
+end

data/spec/hoygancop_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require_relative 'spec_helper'
+require 'hoygancop'
+
+describe Hoygancop do
+  subject{ Hoygancop }
+  describe "#rules" do
+    describe "default set of rules" do
+      it "includes caps" do
+        subject.default_rules.must_include 'too_much_caps'
+      end
+
+      it "includes marks" do
+        subject.default_rules.must_include 'too_much_caps'
+      end
+
+      it "includes hoygan" do
+        subject.default_rules.must_include 'too_much_caps'
+      end
+    end
+  end
+
+  describe "#ruleset" do
+    describe "rule mapping to a class" do
+      let(:ruleset){ subject.ruleset(%w{too_much_caps too_much_marks}) }
+
+      it "includes subject::Rules::TooMuchCaps" do
+        ruleset.must_include subject::Rules::TooMuchCaps
+      end
+
+      it "includes subject::Rules::TooMuchMarks" do
+        ruleset.must_include subject::Rules::TooMuchMarks
+      end
+
+      it "includes subject::Rules::StartsWithHoygan" do
+        ruleset.wont_include subject::Rules::StartsWithHoygan
+      end
+    end
+  end
+
+  describe "integration" do
+    describe "#hoygan?" do
+      it "returns true if any starts with hoygan" do
+        subject.hoygan?("Hoygan, ayudenme").must_equal true
+      end
+
+      it "returns true if too much caps" do
+        subject.hoygan?("TENGO UN PROBLEMA PODRIAN AYUDARME?").must_equal true
+      end
+
+      it "returns false if not hoygan" do
+        text = "Buenos días. ¿Podrían ayudarme con un problema, por favor?"
+        subject.hoygan?(text).must_equal false
+      end
+    end
+
+    describe '#correct' do
+      sentences =
+        ['Hoygan ayudenme',
+          'HOYGAN TENGO UN AMIGO CON UN PROBLEMA AYUDENME!!!!!!!!!!',
+          'HOYGAN AYUDENME TENGO UN PROBLEMA!!!!!'
+      ]
+
+      sentences.each do |sentence|
+        it "de-hoyganizes #{sentence}" do
+          corrected = subject.correct(sentence)
+          subject.hoygan?(corrected).must_equal false
+        end
+      end
+    end
+
+    describe '#report' do
+      let(:report){ subject.report 'HOYGAN AYUDENME TENGO UN PROBLEMA!!!!!' }
+
+      it "includes caps error" do
+        report.must_include :too_much_caps
+      end
+
+      it "includes hoygan error" do
+        report.must_include :starts_with_hoygan
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/reporters'
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+require 'mocha'
+
+require_relative 'support/rule_matcher'

data/spec/support/rule_matcher.rb

@@ -0,0 +1,30 @@
+module RuleMatcher
+  def self.included(base)
+    base.class_eval do
+
+      describe "#hoygan?" do
+        it "returns true when is hoygan" do
+          subject.new(hoygan).hoygan?.must_equal true
+        end
+
+        it "returns false if isn't hoygan" do
+          subject.new(correct).hoygan?.must_equal false
+        end
+      end
+
+      describe "#correct" do
+        it "returns a corrected text" do
+          corrected = subject.new(hoygan).correct
+          subject.new(corrected).hoygan?.must_equal false
+        end
+      end
+
+      describe "#report" do
+        it "returns an appropiate report if hoygan" do
+          rule = subject.new(hoygan)
+          rule.report.must_equal report
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hoygancop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josep Jaume Rey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70240654715640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70240654715640
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70240654715040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70240654715040
+description: A gem for easy detection and correction of hoygans
+email:
+- josepjaume@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- Rakefile
+- Readme.md
+- hoygan.gemspec
+- lib/hoygancop.rb
+- lib/hoygancop/rules.rb
+- lib/hoygancop/rules/ayudenme.rb
+- lib/hoygancop/rules/simple_rule.rb
+- lib/hoygancop/rules/starts_with_hoygan.rb
+- lib/hoygancop/rules/too_much_caps.rb
+- lib/hoygancop/rules/too_much_marks.rb
+- lib/hoygancop/support.rb
+- lib/hoygancop/version.rb
+- spec/hoygancop/rules/ayudenme_spec.rb
+- spec/hoygancop/rules/simple_rule_spec.rb
+- spec/hoygancop/rules/starts_with_hoygan_spec.rb
+- spec/hoygancop/rules/too_much_caps_spec.rb
+- spec/hoygancop/rules/too_much_marks_spec.rb
+- spec/hoygancop_spec.rb
+- spec/spec_helper.rb
+- spec/support/rule_matcher.rb
+homepage: http://github.com/scumbag/hoygan
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A gem for easy detection and correction of hoygans
+test_files:
+- spec/hoygancop/rules/ayudenme_spec.rb
+- spec/hoygancop/rules/simple_rule_spec.rb
+- spec/hoygancop/rules/starts_with_hoygan_spec.rb
+- spec/hoygancop/rules/too_much_caps_spec.rb
+- spec/hoygancop/rules/too_much_marks_spec.rb
+- spec/hoygancop_spec.rb
+- spec/spec_helper.rb
+- spec/support/rule_matcher.rb