sailcalc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aba36f27c999040fb014036457dda3f2442dbe00
+  data.tar.gz: bf84f8ba5685f299875bc26b856dc222087c684e
+SHA512:
+  metadata.gz: e35f387546c8eca7afd5b2fa8999036f61e1ea9473e73075fae7e4f46b7b1f697d788bf4b232639ed25a518a8c662e3d7a26845c672371273290646b98f828e3
+  data.tar.gz: b6c9766f622886bd888a940773d612f246f80dc4492ab90ca128b846aa3f336690b442f53a5a51c2c980f2340b1b532624b022541a8c43f22e335298b315557a

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sailcalc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Trevor Reiff
+
+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,118 @@
+# Sailcalc
+
+Gem provides access to commenly used sailboat and yacht design formula.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sailcalc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sailcalc
+
+## Methods
+
+### Sailcalc.dl_ratio(disp, lwl)
+
+Calculates the displacement to length ratio of the vessel.   
+Required Parameters.  
+
+* disp : vessel displacement in lbs.
+* lwl : waterline length of vessel in ft.
+
+```
+Sailcalc.dl_ratio(20_000, 30)  
+=> 330.69
+```
+### Sailcalc.hull_speed(lwl)
+
+Calculates the theoretical hull speed of the vessel.   
+Required Parameters.  
+
+* lwl : waterline length of vessel in ft.
+
+```
+Sailcalc.hull_speed(30)  
+=> 7.34
+```
+
+### Sailcalc.sa_disp(disp, sa)
+
+Calculates the sail area to displacement ratio of the vessel.   
+Required Parameters.  
+
+* disp : vessel displacement in lbs.
+* sa : sail area of vessel in sq.ft.
+
+```
+Sailcalc.sa_disp(18_250, 810)  
+=> 18.71
+```
+
+### Sailcalc.len_beam(loa, bmax)
+
+Calculates the length to beam ratio of the vessel.   
+Required Parameters.  
+
+* loa : vessel length overall in ft.
+* bmax : maximum beam of vessel in ft.
+
+```
+Sailcalc.len_beam(42, 14.5)  
+=> 2.9
+```
+
+### Sailcalc.cap(disp, bmax)
+
+Calculates the "capsize number" of the vessel.   
+Required Parameters.  
+
+* disp : vessel displacement in lbs.
+* bmax : maximum beam of vessel in ft.
+
+```
+Sailcalc.cap(18_500, 14)  
+=> 2.12
+```
+### Sailcalc.bal_disp(disp, bal)
+
+Calculates the balast to displacement ratio of the vessel. returns a percentage.   
+Required Parameters.  
+
+* disp : vessel displacement in lbs.
+* bal : vessel ballast weight in lbs.
+
+```
+Sailcalc.bal_disp(20_000, 9_200)  
+=> 46.0
+```
+
+### Sailcalc.mcr(disp, lwl, loa, bmax)
+
+Calculates the motion comfort number of the vessel.   
+Required Parameters.  
+
+* disp : vessel displacement in lbs.
+* lwl : waterline length of vessel in ft.
+* loa : vessel length overall in ft.
+* bmax : maximum beam of vessel in ft.
+
+```
+Sailcalc.mcr(20_000, 30, 34, 12.7)  
+=> 31.32
+```
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sailcalc/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,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/sailcalc.rb

@@ -0,0 +1,33 @@
+require "sailcalc/version"
+
+class Sailcalc
+  def self.dl_ratio(disp, lwl)
+    longTons = disp.to_f / 2240
+    (longTons / (0.01 * lwl)**3).round(2)
+  end
+
+  def self.hull_speed(lwl)
+    (1.34 * (lwl.to_f)**0.5).round(2)
+  end
+
+  def self.sa_disp(disp, sa)
+    disp_cu_feet = disp / 64
+    (sa.to_f / (disp_cu_feet**0.6666)).round(2)
+  end
+
+  def self.len_beam(loa, bmax)
+    (loa.to_f / bmax).round(2)
+  end
+
+  def self.cap(disp, bmax)
+    (bmax.to_f / (disp/64)**0.3333).round(2)
+  end
+
+  def self.bal_disp(disp, bal)
+    ((bal.to_f / disp)*100).round(2)
+  end
+
+  def self.mcr(disp, lwl, loa, bmax)
+    (disp / (0.6666*((0.7*lwl) + (0.3333*loa))*(bmax**1.3333))).round(2)
+  end
+end

data/lib/sailcalc/version.rb

@@ -0,0 +1,3 @@
+class Sailcalc
+  VERSION = "1.0.0"
+end

data/sailcalc.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sailcalc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sailcalc"
+  spec.version       = Sailcalc::VERSION
+  spec.authors       = ["Trevor Reiff"]
+  spec.email         = ["trevorreiff@gmail.com"]
+  spec.summary       = %q{Common yacht design formulas.}
+  spec.description   = %q{Common yacht design formulas.}
+  spec.homepage      = "https://github.com/treiff/sailcalc"
+  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"
+end

data/spec/sailcalc_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Sailcalc do
+  describe 'dl_ratio' do
+    subject { Sailcalc.dl_ratio(20000, 38) }
+
+    it 'calculates the displacement to length ratio' do
+      expect(subject).to eql(162.72)
+    end
+  end
+
+  describe 'hull_speed' do
+    subject { Sailcalc.hull_speed(26) }
+
+    it 'calculates the hull speed of the displacement hull' do
+      expect(subject).to eql(6.83)
+    end
+  end
+
+  describe 'sa_disp' do
+    subject { Sailcalc.sa_disp(20000, 680) }
+
+    it 'calculates the sail area to displacement ratio' do
+      expect(subject).to eql(14.79)
+    end
+  end
+
+  describe 'len_beam' do
+    subject { Sailcalc.len_beam(40, 12) }
+
+    it 'calculates the length to beam ratio' do
+      expect(subject).to eql(3.33)
+    end
+  end
+
+  describe 'cap' do
+    subject { Sailcalc.cap(24000, 12) }
+
+    it 'calculates the capsize ratio' do
+      expect(subject).to eql(1.66)
+    end
+  end
+
+  describe 'bal_disp' do
+    subject { Sailcalc.bal_disp(24000, 9000) }
+
+    it 'calculates the balast to displacement ratio' do
+      expect(subject).to eql(37.5)
+    end
+  end
+
+  describe 'mcr' do
+    subject { Sailcalc.mcr(32500, 39, 44, 13.5) }
+
+    it 'calculates the motion comfort ratio' do
+      expect(subject).to eql(36.15)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'sailcalc'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: sailcalc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trevor Reiff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Common yacht design formulas.
+email:
+- trevorreiff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sailcalc.rb
+- lib/sailcalc/version.rb
+- sailcalc.gemspec
+- spec/sailcalc_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/treiff/sailcalc
+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.3
+signing_key: 
+specification_version: 4
+summary: Common yacht design formulas.
+test_files:
+- spec/sailcalc_spec.rb
+- spec/spec_helper.rb