suj-kana-validator 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 SkillupJapan Corp.
+
+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.rdoc

@@ -0,0 +1,26 @@
+= KanaValidator
+
+Adds methods to validate if your strings are composed of only kana, hiragana, katakana or kanji
+only.
+
+== Usage
+
+class User < ActiveRecord::Base
+
+  validates_is_hiragana :name_hiragana, :allow_blank => true
+  validates_is_kanji :name_kanji
+
+end
+
+== Available validators
+
+  validates_is_kana
+  validates_is_kanji
+  validates_is_hiragana
+  validates_is_katakana
+  validates_is_half_katakana
+
+== Options
+
+  allow_blank - Default to true
+  allow_nil   - Deafult to true

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsKanaValidator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/suj/kana-validator.rb

@@ -0,0 +1,2 @@
+require "suj/kana-validator/version"
+require "suj/kana-validator/kana-validator"

data/lib/suj/kana-validator/core_ext/string.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+# Skillupjapan core extensions.
+#
+# Author: Horacio Sanson (horacio@skillupjapan.co.jp)
+#
+# Resources:
+#
+#   http://www.rikai.com/library/kanjitables/kanji_codes.unicode.shtml
+
+module SUJ
+  module Core
+    module String
+
+      def is_katakana?
+        (self =~ /^[゠-ヿ　-〿]+$/) == 0
+      end
+
+      def is_half_katakana?
+        (self =~ /^[｟-ﾟ　-〿]+$/) == 0
+      end
+
+      def is_hiragana?
+        (self =~ /^[ぁ-ゟ　-〿]+$/) == 0
+      end
+
+      def is_kanji?
+        (self =~ /^[一-龯　-〿]+$/) == 0
+      end
+
+      def is_kana?
+        (self =~ /^[゠-ヿ｟-ﾟぁ-ゟ一-龯　-〿]+$/) == 0
+      end
+    end
+  end
+end
+
+String.send(:include, SUJ::Core::String)

data/lib/suj/kana-validator/kana-validator.rb

@@ -0,0 +1,81 @@
+# Custom ActiveRecord::Base validation module.
+#
+# Author: Horacio Sanson (horacio@skillupjapan.co.jp)
+#
+# Rails Usage:
+#
+# In your model you may use these methods to validate if a input string is
+# kanji, hiragana, katakana, half_katanana or kana.
+#
+#   validates_is_kanji :field_name, :allow_blank => false, :allow_nil => false
+#   validates_is_hiragana :field_name
+#   validates_is_katakana :field_name, :allow_blank => false
+#
+# Ruby Usage:
+#
+# This gem also add these methods to the String class:
+#
+#   is_kana?
+#   is_kanji?
+#   is_hiragana?
+#   is_katakana?
+#   is_half_katakana?
+#
+#
+#
+# Resources:
+#   http://chrisblunt.com/2009/04/18/rails-writing-dry-custom-validators/
+#   Advanced Rails Recipes
+
+require File.join(File.dirname(File.expand_path(__FILE__)), "core_ext", "string")
+
+module SUJ
+  module Rails
+    module Validations
+
+      def validates_is_kanji(*attr_names)
+        validate_japanese("kanji", *attr_names)
+      end
+
+      def validates_is_hiragana(*attr_names)
+        validate_japanese("hiragana", *attr_names)
+      end
+
+      def validates_is_katakana(*attr_names)
+        validate_japanese("katakana", *attr_names)
+      end
+
+      def validates_is_half_katakana(*attr_names)
+        validate_japanese("half_katakana", *attr_names)
+      end
+
+      def validates_is_kana(*attr_names)
+        validate_japanese("kana", *attr_names)
+      end
+
+      private
+
+      def error_message(type)
+        "must be #{type}"
+      end
+
+      def validate_japanese(type, *attr_names)
+        configuration = { :allow_nil => true, :allow_blank => true, :message => error_message(type) }
+        configuration.update(attr_names.extract_options!)
+
+        validates_each(attr_names) do |record, attr_name, value|
+          if value.nil?
+            record.errors.add(attr_name, configuration[:message]) if ! configuration[:allow_nil]
+          elsif value.empty?
+            record.errors.add(attr_name, configuration[:message]) if ! configuration[:allow_blank]
+          else
+            record.errors.add(attr_name, configuration[:message]) if ! value.send("is_#{type}?")
+          end
+        end
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.extend(SUJ::Rails::Validations)

data/lib/suj/kana-validator/version.rb

@@ -0,0 +1,5 @@
+module SUJ
+  module KanaValidator
+    VERSION = "0.0.1"
+  end
+end

data/lib/suj/tasks/kana_validator_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails-kana-validator do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/test/dummy/app/assets/stylesheets/users.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,83 @@
+class UsersController < ApplicationController
+  # GET /users
+  # GET /users.json
+  def index
+    @users = User.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @users }
+    end
+  end
+
+  # GET /users/1
+  # GET /users/1.json
+  def show
+    @user = User.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @user }
+    end
+  end
+
+  # GET /users/new
+  # GET /users/new.json
+  def new
+    @user = User.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @user }
+    end
+  end
+
+  # GET /users/1/edit
+  def edit
+    @user = User.find(params[:id])
+  end
+
+  # POST /users
+  # POST /users.json
+  def create
+    @user = User.new(params[:user])
+
+    respond_to do |format|
+      if @user.save
+        format.html { redirect_to @user, notice: 'User was successfully created.' }
+        format.json { render json: @user, status: :created, location: @user }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /users/1
+  # PUT /users/1.json
+  def update
+    @user = User.find(params[:id])
+
+    respond_to do |format|
+      if @user.update_attributes(params[:user])
+        format.html { redirect_to @user, notice: 'User was successfully updated.' }
+        format.json { head :ok }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /users/1
+  # DELETE /users/1.json
+  def destroy
+    @user = User.find(params[:id])
+    @user.destroy
+
+    respond_to do |format|
+      format.html { redirect_to users_url }
+      format.json { head :ok }
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  validates_is_kanji :name_kana
+  validates_is_hiragana :name_hiragana
+  validates_is_katakana :name_halfkana
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>