string_tensions 0.0.1

data/.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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in string_tensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Choan Galvez
+
+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,42 @@
+# StringTensions
+
+A library for calculating musical string tension (from known unit weight, length and pitch) and unit weight (from known tension, length and pitch).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'string_tensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string_tensions
+
+## Usage
+
+Currently the library only accepts input in imperial units (length in inches, unit weight in lbs/inch, tension in lbs). Output is imperial too (unit weight in lbs/inch, tension in lbs).
+
+Should you need output in International System units, there are some conversors included.
+
+StringTensions uses [NoteFrequencies](https://github.com/choan/note_frequencies) internally for converting pitches to frequencies.
+
+Get tension for known unit weight, length and pitch:
+
+    StringTensions.tension_for_pitch(0.00001418, 25.5, "e'")
+
+Get unit weight for known tension, length and pitch:
+
+    StringTensions.uw_for_pitch(10.4, 25.5, "e'")
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/string_tensions/convert.rb

@@ -0,0 +1,31 @@
+require 'ruby-units'
+
+module StringTensions
+  module Convert
+  
+    def self.kg_to_lbs(kg)
+      unit(kg, 'kg').to('lbs').scalar.to_f
+    end
+    
+    def self.lbs_to_kg(pounds)
+      unit(pounds, 'lbs').to('kg').scalar.to_f
+    end
+  
+    def self.inches_to_mm(inches)
+      unit(inches, 'inch').to('mm').scalar.to_f
+    end
+    
+    def self.mm_to_inches(mm)
+      unit(mm, 'mm').to('inch').scalar.to_f
+    end
+    
+    def self.g_m_to_lbs_inch(g)
+      unit(g, 'g/m').to('lbs/inch').scalar.to_f
+    end
+  
+    def self.unit(qty, dim)
+      ::Unit.new("#{qty} #{dim}")
+    end
+  
+  end  
+end

data/lib/string_tensions/version.rb

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

data/lib/string_tensions.rb

@@ -0,0 +1,31 @@
+require "string_tensions/version"
+require "string_tensions/convert"
+require "note_frequencies"
+
+module StringTensions
+  
+  K = 386.4
+  
+  def self.tension(uw_lbs_inch, length_in_inches, freq)
+    # T (Tension) =  (UW  x (2 x L x F)**2) / 386.4
+    (uw_lbs_inch * (2 * length_in_inches * freq)**2) / K
+  end
+  
+  def self.tension_for_pitch(uw_lbs_inch, length_in_inches, pitch)
+    tension(uw_lbs_inch, length_in_inches, freq_from_pitch(pitch))
+  end
+  
+  def self.uw(tension_lbs, length_inches, freq)
+    # UW (unit weight) =  (T x 386.4) / (2 x L x F)**2
+    ((tension_lbs * K) / (2 * length_inches * freq)**2).to_f
+  end
+  
+  def self.uw_for_pitch(tension_lbs, length_inches, pitch)
+    uw(tension_lbs, length_inches, freq_from_pitch(pitch))
+  end
+    
+  def self.freq_from_pitch(pitch)
+    NoteFrequencies.frequency_from_name(pitch)
+  end
+  
+end

data/string_tensions.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'string_tensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_tensions"
+  spec.version       = StringTensions::VERSION
+  spec.authors       = ["Choan Galvez"]
+  spec.email         = ["choan.galvez@gmail.com"]
+  spec.description   = %q{Calculator for musical strings tensions}
+  spec.summary       = %q{StringTensions is a module designed for musical string tension/MPL calculations}
+  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_dependency "note_frequencies"
+  spec.add_dependency "ruby-units"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/helpers.rb

@@ -0,0 +1,4 @@
+def round(q, precision)
+  pow = 10**precision
+  (q * pow).round / pow.to_f
+end

data/test/test_convert.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'helpers'
+require 'string_tensions/convert'
+
+class ConvertTest < Test::Unit::TestCase
+  def test_mm_to_inches
+    assert_equal 1, StringTensions::Convert.mm_to_inches(25.4)
+  end
+  
+  def test_inches_to_mm
+    assert_equal 25.4, StringTensions::Convert.inches_to_mm(1)
+  end
+  
+  def test_kg_to_lbs
+    assert_equal 2.20462262, round(StringTensions::Convert.kg_to_lbs(1), 8)
+  end
+  
+  def test_lbs_to_kg
+    assert_equal 4, round(StringTensions::Convert.lbs_to_kg(2.20462262 * 4), 0)
+  end
+  
+  def test_g_m_to_lbs_inch
+    assert_equal 0.00055997, round(StringTensions::Convert.g_m_to_lbs_inch(10), 8)
+  end
+  
+end

data/test/test_string_tensions.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'helpers'
+require 'string_tensions'
+
+class StringTensionsTest < Test::Unit::TestCase
+
+  def test_tension
+    assert_equal 10.4, round(StringTensions.tension_for_pitch(0.00001418, 25.5, "e'"), 1)
+    assert_equal 11.6, round(StringTensions.tension_for_pitch(0.00001418, 25.5, "f'"), 1)
+  end
+  
+  def test_uw
+    assert_equal 0.000014219248492925078, StringTensions.uw_for_pitch(10.4, 25.5, "e'").to_f
+    assert_equal 0.00001793812886799779, StringTensions.uw_for_pitch(13.12, 25.5, "e'").to_f
+  end  
+  
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: string_tensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Choan Galvez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: note_frequencies
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-units
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Calculator for musical strings tensions
+email:
+- choan.galvez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/string_tensions.rb
+- lib/string_tensions/convert.rb
+- lib/string_tensions/version.rb
+- string_tensions.gemspec
+- test/helpers.rb
+- test/test_convert.rb
+- test/test_string_tensions.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 714457889
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 714457889
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: StringTensions is a module designed for musical string tension/MPL calculations
+test_files:
+- test/helpers.rb
+- test/test_convert.rb
+- test/test_string_tensions.rb