genderize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 226303c271bd8c4dc9f298be2c014453d1bccf99
+  data.tar.gz: 4073b1bc58083b32b482cbd5019f0da942e20ccc
+SHA512:
+  metadata.gz: a0a3da0bd342197cb770753a8736f2ce8e4035999e392db4252322357f03c3354ee3a9df6bf406973fa889a1a737d9c030e6d0adf8c5f7204b8928a40b57113c
+  data.tar.gz: 69065b24677786d332dca244834dc19f548e0cb3bbd53cf9bb23922a31968a16a591ae957d0eb76c2e4203286d6b5093fb3c7b738c0614a8d8f676e967059af6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Katana Code Ltd.
+
+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,82 @@
+# Genderize
+
+Genderize is a simple Rails gem for adding gender helper methods to Rails models.
+
+## Example
+
+
+    # Setting the gender is simple - just set the attribute value to "m" or "f"
+    @user = User.new(gender: "f")
+
+    # This gives us a few helper methods to add gender specific text to our views
+    @user.gender.male? # => false  
+    @user.gender.name # => "female"
+    @user.gender.to_s # => "f"
+    @user.gender.abbr # => "f"
+    
+    # gender pronouns
+    # As the subject of a sentence
+    @user.gender.subject # => 'she'
+    # As the object of a sentence
+    @user.gender.object # => 'her'
+    # Showing possession
+    @user.gender.possessive # => 'her'
+    # Writing a casual form of the gender
+    @user.gender.casual # => "chick"
+  
+## Installation
+
+Add this to your Gemfile:
+
+
+    gem "genderize"
+
+...and run `bundle install` to install the gem.
+
+Next, run:
+
+    $ rails g genderize:install
+
+... to install the genderize.en.yml file in your locales directory
+
+Finally, to *genderize* a model attribute:
+
+
+    class User < ActiveRecord::Base
+
+      genderize
+      
+      # ... or, if your db column isn't named `gender`
+      genderize(:user_gender)
+
+    end
+
+
+## Issues
+
+If you discover a problem with Genderize, please let us know about it.
+
+**Remember** to search the [issues list](https://github.com/KatanaCode/genderize/issues) first in case your issue has already been raised
+by another Githuber
+
+## Documentation
+
+Full documentation is available here: http://rubydoc.info/gems/blogit
+
+## Contributing
+
+You're welcome to contribute to Genderize.
+
+## Legal Stuff
+
+Copyright 2013 [Katana Code Ltd.](http://katanacode.com)
+
+See (LEGAL)[LEGAL] for full details.
+
+## Credits
+
+Developed by [Katana Code](http://katanacode.com)
+
+## About Katana Code
+
+Katana Code are [Ruby on Rails Developers Based in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").

data/Rakefile

@@ -0,0 +1,39 @@
+#!/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    = 'Blog'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+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/app/assets/javascripts/genderize/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/genderize/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * 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/app/controllers/genderize/application_controller.rb

@@ -0,0 +1,4 @@
+module Genderize
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/genderize/application_helper.rb

@@ -0,0 +1,4 @@
+module Genderize
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/genderize/application.html.erb

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

data/config/locales/genderize.en.yml

@@ -0,0 +1,23 @@
+en:
+  genderize:
+    name:
+      masculine: "male"
+      feminine: "female"
+        
+  # pronouns
+    subject:
+      masculine: 'he'
+      feminine: 'she'
+    
+    object:
+      masculine: 'him'
+      feminine: 'her'
+      
+    possessive:
+      masculine: 'his'
+      feminine: 'her'
+    
+    # Other forms
+    casual:
+      masculine: guy
+      feminine: girl

data/config/routes.rb

@@ -0,0 +1,2 @@
+Genderize::Engine.routes.draw do
+end

data/lib/genderize.rb

@@ -0,0 +1,9 @@
+require "genderize/genderize"
+require "genderize/engine"
+
+unless Rails
+  raise "Genderize is a Rails gem and expects to used in a Rails (3 or higher) application"
+end
+
+module Genderize
+end

data/lib/genderize/engine.rb

@@ -0,0 +1,14 @@
+module Genderize
+  class Engine < ::Rails::Engine
+    isolate_namespace Genderize
+    
+    initializer "genderize.extend_active_record" do
+
+      if defined?(::ActiveRecord::Base)
+        ::ActiveRecord::Base.send(:include, Genderize)
+      end
+      
+    end
+    
+  end
+end

data/lib/genderize/gender.rb

@@ -0,0 +1,50 @@
+module Genderize
+  class Gender
+  
+    include I18n
+
+    attr_reader :name, :abbr, :subject, :object, :possessive, :casual
+
+    def initialize(abbr)
+      raise "Invalid abbreviation" unless abbr.to_s =~ /\A(f|m)\Z/i
+      @abbr = abbr.downcase
+      @male = self.abbr == 'm'
+      @name = male? ? t("name") : t("name", "feminine")
+    
+      # pronouns
+      @subject    = male? ? t("subject") : t("subject", "feminine")
+      @object     = male? ? t("object") : t("object", "feminine")
+      @possessive = male? ? t("possessive") : t("possessive", "feminine")
+    
+      # Other forms
+      @casual     = male? ? t("casual") : t("casual", "feminine")
+    end
+  
+    def capital_abbr
+      abbr.capitalize
+    end
+  
+    def male?
+      @male
+    end
+  
+    def female?
+      !male?
+    end
+  
+    def to_s
+      @abbr
+    end
+  
+    def ==(val)
+      to_s == val.to_s
+    end
+  
+    private
+  
+    def t(attribute, gender = "masculine")
+      I18n.t("genderize.#{attribute}.#{gender}")
+    end
+    
+  end
+end

data/lib/genderize/genderize.rb

@@ -0,0 +1,44 @@
+require "genderize/gender"
+
+module Genderize::Genderize
+
+  def self.included(base)
+    base.extend(Genderize::Genderize::ClassMethods)
+  end
+  
+  module ClassMethods
+    
+    def genderize(col_name = "gender")
+      
+      # Reads the DB column value for gender attribute and creates a new Gender 
+      # object with it's value
+      #
+      # The object is memoized for future calls.
+      # 
+      # Returns a Gender
+      define_method col_name do
+        if value = instance_variable_get("@#{col_name}")
+          return value
+        else
+          instance_variable_set("@#{col_name}", Gender.new(read_attribute(col_name)))
+        end
+      end
+      
+      # Writes to the DB column the new value for the gender attribute
+      # Sets the instance varaible value too
+      #
+      # string - A String indicating the gender. Must be either 'm', "M", 'f' or "F".
+      #
+      # Raises ArgumentError if gender is not a single alphanumeric character "m" or "f"
+      define_method "#{col_name}=" do |string|
+        unless string.to_s =~ /\A(m|f)\Z/i
+          raise ArgumentError, "Gender must be a single alphanumeric character" 
+        end
+        write_attribute(col_name, string)
+        instance_variable_set("@#{col_name}", Gender.new(read_attribute(col_name)))
+      end
+      
+    end
+    
+  end
+end

data/lib/genderize/version.rb

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

data/lib/generators/genderize/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/genderize/install/install_generator.rb

@@ -0,0 +1,12 @@
+class Genderize::InstallGenerator < Rails::Generators::Base
+
+  # Gem's root dir
+  source_root File.expand_path('../../../../..', __FILE__)
+
+  desc "Installs the genderize.yml files to your locales directory"
+
+  def copy_initializer
+    template "config/locales/genderize.en.yml", "config/locales/genderize.en.yml"
+  end
+
+end

data/lib/tasks/genderize_tasks.rake

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

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.