model_citizen 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dbedf18cde1a51229bc07787b9f8d3a31834828
+  data.tar.gz: effa351e539c1201a2298f8a88801816d5b2426c
+SHA512:
+  metadata.gz: b8c04776ed0b93e1739e55f97335a113c23701d5312aa8e32cb3d32a5860b4ca971b2595ded3bbd19e2cc9b97fbaedf29b1ded93fcabcb76c95c5485230f5d1c
+  data.tar.gz: e768bb1b3ed02ca7d58bfc851fee96abbda32c12c9ad2cc49434b051fe1b6717970ab8c113b21bd3b292ec8d41ce63878bc21bae4df2acdad3ee1daf2d7c86f5

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sylwia Olak
+
+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,27 @@
+# ModelCitizen
+
+Provides validation methods to LumberYard Sinatra app and LumberYard command line app models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_citizen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install model_citizen
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/model_citizen/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/lib/model_citizen/messages.rb

@@ -0,0 +1,25 @@
+module ModelCitizen
+  class Messages
+
+    attr_reader :messages
+
+    def initialize
+      @messages = {"username_prompt" => "Please enter your username.",
+                   "choose_action" => "Please select what you'd like to do." ,
+                   "invalid_choice" => "That is not a valid choice, please try again.",
+                   "enter_employee_first" => "Please enter employee first name.",
+                   "enter_employee_last" => "Please enter employee last name.",
+                   "enter_employee_username" => "Please enter employee username.",
+                   "enter_employee_type" => "Please enter employee type (admin or non-admin).",
+                   "enter_client_name" => "Please enter client name.",
+                   "enter_client_type" => "Please enter client type (if regular client, please enter 'standard').",
+                   "enter_date" => "Please input the project date using this format : YYYY/MM/DD",
+                   "future_date_error" => "You cannot log time for the future, please select a different date.",
+                   "enter_hours" => "Please input hours worked"}
+    end
+
+    def get_message(message_choice)
+      @messages.fetch(message_choice)
+    end
+  end
+end

data/lib/model_citizen/validations.rb

@@ -0,0 +1,33 @@
+require 'date'
+module ModelCitizen
+  class Validations
+
+    def not_nil_or_empty?(attributes)
+      !attributes.include?(nil) && !attributes.include?("")
+    end
+
+    def value_included?(*value, attribute)
+      [*value].include? attribute
+    end
+
+    def valid_date?(date)
+      valid_string?(date) && past_date?(date)
+    end
+
+    def no_duplicates?(value, data_structure)
+      !data_structure.include? value
+    end
+
+    private
+
+    def valid_string?(date)
+      y, m, d = date.split '/'
+      return false if y.to_i == 0
+      Date.valid_date? y.to_i, m.to_i, d.to_i
+    end
+
+    def past_date?(date)
+      Date.parse(date) < Date.today
+    end
+  end
+end

data/lib/model_citizen/version.rb

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

data/lib/model_citizen.rb

@@ -0,0 +1,8 @@
+require 'model_citizen/version'
+require 'model_citizen/messages'
+require 'model_citizen/validations'
+require 'date'
+
+module ModelCitizen
+end
+

data/model_citizen.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'model_citizen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "model_citizen"
+  spec.version       = ModelCitizen::VERSION
+  spec.authors       = ["Sylwia Olak"]
+  spec.email         = ["pumpkincouture@gmail.com"]
+  spec.summary       = %q{Provides validation methods for models in the LumberYard Sinatra app and command line application.}
+  spec.homepage      = "https://github.com/pumpkincouture/model_citizen"
+  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.1.0"
+end

data/spec/messages_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe ModelCitizen::Messages do
+
+  context "displaying messages" do
+    it "should return a prompt to enter username" do
+      type_validator = ModelCitizen::Messages.new.get_message("username_prompt")
+      expect(type_validator).to eq("Please enter your username.")
+    end
+
+    it "should return a choose action message" do
+      type_validator = ModelCitizen::Messages.new.get_message("choose_action")
+      expect(type_validator).to eq("Please select what you'd like to do.")
+    end
+
+    it "should return an error message" do
+      type_validator = ModelCitizen::Messages.new.get_message("invalid_choice")
+      expect(type_validator).to eq("That is not a valid choice, please try again.")
+    end
+
+    it "should return a prompt to enter employee first name" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_employee_first")
+      expect(type_validator).to eq("Please enter employee first name.")
+    end
+
+    it "should return a prompt to enter employee last name" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_employee_last")
+      expect(type_validator).to eq("Please enter employee last name.")
+    end
+
+    it "should return a prompt tp enter employee username" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_employee_username")
+      expect(type_validator).to eq("Please enter employee username.")
+    end
+
+    it "should return a prompt to enter employee type" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_employee_type")
+      expect(type_validator).to eq("Please enter employee type (admin or non-admin).")
+    end
+
+    it "should return a prompt to enter client name" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_client_name")
+      expect(type_validator).to eq("Please enter client name.")
+    end
+
+    it "should return a prompt for client type" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_client_type")
+      expect(type_validator).to eq("Please enter client type (if regular client, please enter 'standard').")
+    end
+
+    it "should return a prompt to input the date" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_date")
+      expect(type_validator).to eq("Please input the project date using this format : YYYY/MM/DD")
+    end
+
+    it "should return an error for logging time in the future" do
+      type_validator = ModelCitizen::Messages.new.get_message("future_date_error")
+      expect(type_validator).to eq("You cannot log time for the future, please select a different date.")
+    end
+
+    it "should return a prompt for hours" do
+      type_validator = ModelCitizen::Messages.new.get_message("enter_hours")
+      expect(type_validator).to eq("Please input hours worked")
+    end
+  end
+end

data/spec/model_citizen_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe ModelCitizen do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'model_citizen/messages'
+require 'model_citizen/validations'
+
+RSpec.configure do |config|
+  config.failure_color = :red
+  config.success_color = :green
+  config.detail_color = :yellow
+  config.tty = true
+  config.color = true
+  config.formatter = :documentation
+  config.order = :rand
+end
+

data/spec/validations_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe ModelCitizen::Validations do
+
+  context "checking attributes for nil or empty values" do
+    it "should return true if no attributes are nil or empty" do
+      first_name_validator = ModelCitizen::Validations.new.not_nil_or_empty?(["Sylwia", "Olak", "solak", "admin"])
+      expect(first_name_validator).to eq(true)
+    end
+
+    it "should return false if there are nil attributes" do
+      first_name_validator = ModelCitizen::Validations.new.not_nil_or_empty?(["Sylwia", "Olak", nil, "admin"])
+      expect(first_name_validator).to eq(false)
+    end
+
+    it "should return false if there are empty string attributes" do
+      first_name_validator = ModelCitizen::Validations.new.not_nil_or_empty?(["Sylwia", "Olak", "solak", ""])
+      expect(first_name_validator).to eq(false)
+    end
+
+    it "should return false if there are any nil or empty attributes" do
+      first_name_validator = ModelCitizen::Validations.new.not_nil_or_empty?([nil, "", "6", ""])
+      expect(first_name_validator).to eq(false)
+    end
+  end
+
+  context "validating whether or not attribute contains a value" do
+    it "should return true if selected attribute matches value argument" do
+      employee_type = "admin"
+      type_validator = ModelCitizen::Validations.new.value_included?("admin", "non-admin", employee_type)
+      expect(type_validator).to eq(true)
+    end
+
+    it "should return false if selected attribute does not match value argument" do
+      employee_type = "uncool"
+      type_validator = ModelCitizen::Validations.new.value_included?("admin", "cool", employee_type)
+      expect(type_validator).to eq(false)
+    end
+
+    it "should return false if attribute does not include value" do
+      employee_type = "non-admin"
+      type_validator = ModelCitizen::Validations.new.value_included?("admin", employee_type)
+      expect(type_validator).to eq(false)
+    end
+  end
+
+  context "validating date strings" do
+    it "should return true if date is valid" do
+      date = "2015/2/3"
+      type_validator = ModelCitizen::Validations.new.valid_date?(date)
+      expect(type_validator).to eq(true)
+    end
+
+    it "should return false if date is missing year" do
+      date = "/2/3"
+      type_validator = ModelCitizen::Validations.new.valid_date?(date)
+      expect(type_validator).to eq(false)
+    end
+
+    it "should return false if date is missing month" do
+      date = "2015//3"
+      type_validator = ModelCitizen::Validations.new.valid_date?(date)
+      expect(type_validator).to eq(false)
+    end
+
+    it "should return false if date is missing day" do
+      date = "2015/2/"
+      type_validator = ModelCitizen::Validations.new.valid_date?(date)
+      expect(type_validator).to eq(false)
+    end
+
+    it "should return true if date is not in the future" do
+      date = "2015/1/15"
+      type_validator = ModelCitizen::Validations.new.valid_date?(date)
+      expect(type_validator).to eq(true)
+    end
+
+    it "should return false if date is in the future" do
+      date = "2016/2/3"
+      type_validator = ModelCitizen::Validations.new.valid_date?(date)
+      expect(type_validator).to eq(false)
+    end
+  end
+
+  context "checking for duplicates" do
+    it "should return true if there are no duplicates" do
+      animals = ["cat", "dog", "parrot", "monkey", "ferret"]
+      type_validator = ModelCitizen::Validations.new.no_duplicates?("capybara", animals)
+      expect(type_validator).to eq(true)
+    end
+
+    it "should return false if there are duplicates" do
+      animals = ["cat", "dog", "parrot", "monkey", "ferret"]
+      type_validator = ModelCitizen::Validations.new.no_duplicates?("ferret", animals)
+      expect(type_validator).to eq(false)
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: model_citizen
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sylwia Olak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email:
+- pumpkincouture@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/model_citizen.rb
+- lib/model_citizen/messages.rb
+- lib/model_citizen/validations.rb
+- lib/model_citizen/version.rb
+- model_citizen.gemspec
+- spec/messages_spec.rb
+- spec/model_citizen_spec.rb
+- spec/spec_helper.rb
+- spec/validations_spec.rb
+homepage: https://github.com/pumpkincouture/model_citizen
+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: Provides validation methods for models in the LumberYard Sinatra app and
+  command line application.
+test_files:
+- spec/messages_spec.rb
+- spec/model_citizen_spec.rb
+- spec/spec_helper.rb
+- spec/validations_spec.rb