optical 0 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb544a2d0d771d7f974dfdee13db65f1c319f491
-  data.tar.gz: 4b82e4f906e8df0ced3a0256d4018c5a3d240f8f
+  metadata.gz: 4f4400f4aa624b50b95186d0ead6ddb5a1c033f9
+  data.tar.gz: b0bed9445d1164a994190e77dcb6192ebd19f119
 SHA512:
-  metadata.gz: 734e368031fd49482e0f777794c7acd9d612703ee96d5fcad9ccd71887f9526bf65f64c8fe6c6da9f9d1b44ae54c29d8884e90cbffbd197407ebdae96220c7c6
-  data.tar.gz: 666d841c393776ca915a65d531f6ea9c402c9239bb64c58293cc1971d2488f9148406791cea694ee3b90d7055fa58ec8c4750eaf92647a4b4f95f0c124e48442
+  metadata.gz: 0014fcd6738e371bb5c03c2d4ccda9dbe22f592faa1513f1696e0749a750920f846b53c6f1a8628dd2be259e04473e5218d32b30aa1443ef8e084564b017086b
+  data.tar.gz: d0ebe9fe8cc259406cf326f617b856d49775fd8fcfd441ca866b6592cd8d96c82dec100105126a53a94f9f6cc3d3d9a77cc53383b214e1221cc55453a2aefae2

data/README.markdown

@@ -1,6 +1,6 @@
 # Optical
 
-TODO: Write a gem description
+Remember that optics class you took in college? Me neither, and that's why I wrote this gem.
 
 ## Installation
 
@@ -18,12 +18,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Lenses
 
-## Contributing
+The optical gem has primitives for modeling generic thin-lenses, as well as more specific lens types.
 
-1. Fork it ( https://github.com/[my-github-username]/optical/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
+To model a simple thin lens, simply...
+
+```ruby
+lens = Optical::Lens.new diameter:12.mm, focal_length:20.mm
+```
+
+A Plano-Convex lens is just as easy to make...
+
+```ruby
+lens = Optical::Lens.new diameter:12.mm, focal_length:20.mm
+```
+
+### Optical Systems
+
+A simple optical system (no splitters) can be modeled using the familiar `push` syntax.
+
+```ruby
+system = Optical::System.new
+system.push Optical::Lens.new
+system.push Optical::Lens.new
+```
+
+The two lenses in that last example won't have any space between, which is almost
+never what you want. You can set the distance between them by pushing a special
+spacer element.
+
+```ruby
+system.push Optical::Lens.new
+system.push Optical::System.spacer(10.mm)
+system.push Optical::Lens.new
+```
+
+or you can simply push any Numeric-like object
+
+```ruby
+system.push Optical::Lens.new
+system.push 10.mm
+system.push Optical::Lens.new
+```
+
+If you have a number of elements that all need the same spacing, you can set a
+default spacing value before pushing the elements. The default value will be in
+effect until changed.
+
+```ruby
+system.spacing = 10.mm
+system.push Optical::Lens.new	# These two elements will get a 10mm spacer
+system.push Optical::Lens.new	#  added between them automatically
+```

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
+task :default => :test
+
+Rake::TestTask.new do |t|
+    t.libs.push 'lib'
+    t.test_files = FileList['test/**/*.rb']
+    t.verbose = true
+end

data/lib/optical.rb

@@ -1,3 +1,6 @@
+require 'optical/lens'
+require 'optical/plano_convex_lens'
+require 'optical/system'
+
 module Optical
-  # Your code goes here...
 end

data/lib/optical/lens.rb

@@ -0,0 +1,58 @@
+module Optical
+    # A representation of a simple thin lens
+    # http://en.wikipedia.org/wiki/Lens_(optics)
+    class Lens
+	# @!attribute [r] focal_length
+	#   @return [Number]  the distance from the principal plane to the focal point
+	attr_reader :focal_length
+
+	def initialize(**options)
+	    options.each {|k,v| respond_to?(k) ? instance_variable_set("@#{k}", v) : raise(ArgumentError, "Unknown argument: '#{k}'") }
+	end
+
+	# @!attribute [r] clear_diameter
+	#   @return [Number]  the diameter of the portion of the {Lens} that meets its stated specifications
+	def clear_diameter
+	    @clear_diameter || (2*@clear_radius)
+	end
+	alias :clear_aperture :clear_diameter
+
+	# @!attribute [r] clear_radius
+	#   @return [Number]  the radius of the portion of the {Lens} that meets its stated specifications
+	def clear_radius
+	    @clear_radius || (@clear_diameter && @clear_diameter/2)
+	end
+
+	# @!attribute [r] center_thickness
+	#   @return [Number]  the thickness of the {Lens} at its center
+	attr_reader :center_thickness
+
+	# @!attribute diameter
+	#   @return [Number]  the physical diameter of the {Lens}
+	def diameter
+	    @diameter || 2*@radius
+	end
+
+	# @!attribute [r] edge_thickness
+	#   @return [Number]  the thickness of the {Lens} at its edge
+	attr_accessor :edge_thickness
+
+	# @!attribute [r] numerical_aperture
+	#   @return [Number]  the numerical aperture of the lens, based on clear_radius (if set; otherwise it's based on radius)
+	def numerical_aperture
+	    Math.sin(Math.atan2(clear_radius || radius, focal_length))
+	end
+
+	# @!attribute [r] radius
+	#   @return [Number]	the physical radius of the {Lens}
+	def radius
+	    @radius || @diameter/2
+	end
+
+	# @!attribute thickness
+	#   @return [Number]  the maximum thickness of the {Lens}
+	def thickness
+	    [@center_thickness, @edge_thickness].max
+	end
+    end
+end

data/lib/optical/plano_convex_lens.rb

@@ -0,0 +1,25 @@
+require_relative 'lens'
+
+module Optical
+    # A representation of a plano convex lens
+    class PlanoConvexLens < Lens
+	# @!attribute radius_of_curvature
+	#   @return [Number]  the radius of curvature of the optical surface
+	attr_reader :radius_of_curvature
+
+	# @!attribute thickness
+	#   @param radius [Number]  the distance from the ceterline of the lens
+	#   @return [Number]  the thickness of the {Lens} at a given distance from the centerline
+	def thickness(_radius=nil, **options)
+	    return super() if !_radius && options.empty?
+
+	    _radius ||= options[:radius] || (options[:diameter]/2)
+
+	    raise ArgumentError, "Requested radius (#{_radius}) is outside of the lens" if _radius > radius
+
+	    if _radius && center_thickness && radius_of_curvature
+		center_thickness - radius_of_curvature + Math.sqrt(radius_of_curvature**2 - _radius**2)
+	    end
+	end
+    end
+end

data/lib/optical/system.rb

@@ -0,0 +1,47 @@
+module Optical
+=begin
+An Optical System is a set of Optical Elements, generally arranged in a line.
+=end
+    class System
+	# @!attribute elements
+	#   @return [Array]  the set of elements in the system
+	attr_reader :elements
+
+	# @!attribute spacing
+	#   @return [Number]  the default spacing to add between newly added elements
+	attr_accessor :spacing
+
+	# Convenience method for creating a new {Spacer}
+	def self.spacer(space)
+	    Spacer::new(space)
+	end
+
+	def initialize
+	    @elements = []
+	end
+
+	# Append a new Optical element
+	# @return [System]
+	def push(element)
+	    if element.is_a?(Numeric)
+		@elements.push Spacer.new(element)
+	    elsif element.is_a?(Spacer)
+		@elements.push element
+	    else
+		@elements.push Spacer.new(spacing) if spacing && !(elements.empty? || elements.last.is_a?(Spacer))
+		@elements.push element
+	    end
+
+	    self
+	end
+
+	class Spacer
+	    attr_reader :space
+
+	    # @param space [Number] the length of the {Spacer}
+	    def initialize(space)
+		@space = space
+	    end
+	end
+    end
+end

data/optical.gemspec

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
     spec.name          = "optical"
-    spec.version       = '0'
+    spec.version       = '0.1'
     spec.authors       = ["Brandon Fosdick"]
     spec.email         = ["bfoz@bfoz.net"]
     spec.summary       = %q{Optical systems in Ruby}
     spec.description   = %q{The home of all ruby optics}
-    spec.homepage      = "http://github.com/TemplateLabs/optical-ruby"
+    spec.homepage      = "http://github.com/bfoz/optical-ruby"
     spec.license       = "BSD"
 
     spec.files         = `git ls-files -z`.split("\x0")

data/test/optical/lens.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'optical/lens'
+
+describe Optical::Lens do
+    it 'must initialize itself from named parameters' do
+	lens = Optical::Lens.new(radius:1, focal_length:5)
+	lens.must_be_instance_of Optical::Lens
+	lens.diameter.must_equal 2
+	lens.focal_length.must_equal 5
+    end
+
+    it 'must have a center thickness' do
+	Optical::Lens.new(center_thickness: 5).center_thickness.must_equal 5
+    end
+
+    it 'must have an edge thickness' do
+	Optical::Lens.new(edge_thickness: 4).edge_thickness.must_equal 4
+    end
+
+    it 'must have a thickness attribute that is the maximum thickness' do
+	Optical::Lens.new(center_thickness:2, edge_thickness:5).thickness.must_equal 5
+    end
+
+    it 'must have a numerical aperture' do
+	lens = Optical::Lens.new(radius:1, focal_length:5)
+	lens.numerical_aperture.must_be_close_to 0.196
+    end
+end

data/test/optical/plano_convex_lens.rb

@@ -0,0 +1,26 @@
+require 'minitest/autorun'
+require 'optical/plano_convex_lens'
+
+describe Optical::PlanoConvexLens do
+    let(:lens) { Optical::PlanoConvexLens.new(center_thickness:3, diameter:15, edge_thickness:2, radius_of_curvature:20) }
+
+    it 'must report the maximum thickness when no arguments are given' do
+	lens.thickness.must_equal 3
+    end
+
+    it 'must report the thickness at a given radius' do
+	lens.thickness(5).must_be_close_to 2.364
+    end
+
+    it 'must report the thickness at a given radius with a named parameter' do
+	lens.thickness(radius:5).must_be_close_to 2.364
+    end
+
+    it 'must report the thickness at a given diameter with a named parameter' do
+	lens.thickness(diameter:10).must_equal lens.thickness(radius:5)
+    end
+
+    it 'must raise an exception if the requested radius is outside the lens' do
+	->{ lens.thickness(radius:10) }.must_raise ArgumentError
+    end
+end

data/test/optical/system.rb

@@ -0,0 +1,60 @@
+require 'minitest/autorun'
+require 'optical/system'
+
+describe Optical::System do
+    let(:subject) { Optical::System.new }
+
+    it 'must not have any elements' do
+	subject.elements.empty?.must_equal true
+    end
+
+    it 'must push a Lens' do
+	subject.push Optical::Lens.new
+	subject.elements.length.must_equal 1
+	subject.elements.last.must_be_instance_of Optical::Lens
+    end
+
+    it 'must push multiple Lenses' do
+	subject.push Optical::Lens.new
+	subject.push Optical::Lens.new
+	subject.elements.length.must_equal 2
+	subject.elements.all? {|e| e.is_a? Optical::Lens }.must_equal true
+    end
+
+    it 'must push a Lens and a Spacer' do
+	subject.push Optical::Lens.new
+	subject.push Optical::System.spacer(10)
+	subject.elements.length.must_equal 2
+	subject.elements.first.must_be_instance_of Optical::Lens
+	subject.elements.last.must_be_instance_of Optical::System::Spacer
+    end
+
+    it 'must push a Lens and a convenience Spacer' do
+	subject.push Optical::Lens.new
+	subject.push 10
+	subject.elements.length.must_equal 2
+	subject.elements.first.must_be_instance_of Optical::Lens
+	subject.elements.last.must_be_instance_of Optical::System::Spacer
+    end
+
+    it 'must have a default spacing between elements' do
+	subject.spacing = 10
+	subject.push Optical::Lens.new
+	subject.push Optical::Lens.new
+	subject.elements.length.must_equal 3
+	subject.elements.first.must_be_instance_of Optical::Lens
+	subject.elements[1].must_be_instance_of Optical::System::Spacer
+	subject.elements.last.must_be_instance_of Optical::Lens
+    end
+
+    it 'must not push two spacers when a default spacing is set' do
+	subject.spacing = 10
+	subject.push Optical::Lens.new
+	subject.push Optical::System.spacer(10)
+	subject.push Optical::Lens.new
+	subject.elements.length.must_equal 3
+	subject.elements.first.must_be_instance_of Optical::Lens
+	subject.elements[1].must_be_instance_of Optical::System::Spacer
+	subject.elements.last.must_be_instance_of Optical::Lens
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optical
 version: !ruby/object:Gem::Version
-  version: '0'
+  version: '0.1'
 platform: ruby
 authors:
 - Brandon Fosdick
@@ -50,8 +50,14 @@ files:
 - README.markdown
 - Rakefile
 - lib/optical.rb
+- lib/optical/lens.rb
+- lib/optical/plano_convex_lens.rb
+- lib/optical/system.rb
 - optical.gemspec
-homepage: http://github.com/TemplateLabs/optical-ruby
+- test/optical/lens.rb
+- test/optical/plano_convex_lens.rb
+- test/optical/system.rb
+homepage: http://github.com/bfoz/optical-ruby
 licenses:
 - BSD
 metadata: {}
@@ -75,4 +81,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Optical systems in Ruby
-test_files: []
+test_files:
+- test/optical/lens.rb
+- test/optical/plano_convex_lens.rb
+- test/optical/system.rb