From d7c07e03ff6160547d325c7cbaa89121bc15b3a6 Mon Sep 17 00:00:00 2001 From: Nicholas Bruning Date: Mon, 4 Nov 2013 23:30:10 +1100 Subject: [PATCH] Initial commit --- .gitignore | 17 +++++++++++++++++ Gemfile | 4 ++++ LICENSE.txt | 22 ++++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++++ Rakefile | 1 + lib/mongoid/enum.rb | 7 +++++++ lib/mongoid/enum/version.rb | 5 +++++ mongoid-enum.gemspec | 23 +++++++++++++++++++++++ 8 files changed, 108 insertions(+) create mode 100644 .gitignore create mode 100644 Gemfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100644 lib/mongoid/enum.rb create mode 100644 lib/mongoid/enum/version.rb create mode 100644 mongoid-enum.gemspec diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d87d4be --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +*.gem +*.rbc +.bundle +.config +.yardoc +Gemfile.lock +InstalledFiles +_yardoc +coverage +doc/ +lib/bundler/man +pkg +rdoc +spec/reports +test/tmp +test/version_tmp +tmp diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..def79ad --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' + +# Specify your gem's dependencies in mongoid-enum.gemspec +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..a0d2b6d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,22 @@ +Copyright (c) 2013 Nicholas Bruning + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f6e0b5 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Mongoid::Enum + +Heavily inspired by DHH's ActiveRecord::Enum, this little library is +really just a good tablespoon of syntactik sugar. + + +# Usage + +class Payment + + enum :status, [:pending, :approved, :declined], + +end + +* Stores as `_status`, accessible from `status` and `status=`. +* Automatically validates against `:options` +* Stored as a string, but always expressed as a symbol. Access is +indifferent (or masks said behaviour + +# Options + +:multiple + +Changes storage to `_status_array`, and allows for the storage of +multiple options. + +Should also include some finders! + +Payment.declined, etc.. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..2995527 --- /dev/null +++ b/Rakefile @@ -0,0 +1 @@ +require "bundler/gem_tasks" diff --git a/lib/mongoid/enum.rb b/lib/mongoid/enum.rb new file mode 100644 index 0000000..589751a --- /dev/null +++ b/lib/mongoid/enum.rb @@ -0,0 +1,7 @@ +require "mongoid/enum/version" + +module Mongoid + module Enum + # Your code goes here... + end +end diff --git a/lib/mongoid/enum/version.rb b/lib/mongoid/enum/version.rb new file mode 100644 index 0000000..efcdbb8 --- /dev/null +++ b/lib/mongoid/enum/version.rb @@ -0,0 +1,5 @@ +module Mongoid + module Enum + VERSION = "0.0.1" + end +end diff --git a/mongoid-enum.gemspec b/mongoid-enum.gemspec new file mode 100644 index 0000000..75d6d57 --- /dev/null +++ b/mongoid-enum.gemspec @@ -0,0 +1,23 @@ +# coding: utf-8 +lib = File.expand_path('../lib', __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'mongoid/enum/version' + +Gem::Specification.new do |spec| + spec.name = "mongoid-enum" + spec.version = Mongoid::Enum::VERSION + spec.authors = ["Nicholas Bruning"] + spec.email = ["nicholas@bruning.com.au"] + spec.description = %q{TODO: Write a gem description} + spec.summary = %q{TODO: Write a gem summary} + spec.homepage = "" + spec.license = "MIT" + + spec.files = `git ls-files`.split($/) + 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.3" + spec.add_development_dependency "rake" +end