rquran 1.0.0

data/lib/rquran/rquran.rb

@@ -0,0 +1,77 @@
+module Rquran 
+  include QuranData
+  
+  def self.sura_name(sura)
+  	SuraNames[sura]
+  end
+
+  def self.page_for_ayah(sura, relative_ayah_index)
+    page = 0 
+    Pages.each do |p|
+      next if p.empty?
+      page += 1 
+      if p[0] == sura and p[1]==relative_ayah_index then 
+        return page
+      elsif p[0] > sura then 
+        return page - 1
+      elsif p[0]==sura and p[1] > relative_ayah_index
+        return page - 1
+      end
+    end
+  end
+
+  def self.page_for_absolute_ayah(absolute_ayah_index)
+    page_for_ayah(   sura_for_ayah(absolute_ayah_index) , relative_ayah_refernce(absolute_ayah_index)  )
+  end
+    
+  def self.absolute_index_for_ayah(sura,relative_ayah_index)
+    Suras[sura][1]+relative_ayah_refernce-1
+  end
+  
+  def self.juzu_for_ayah(sura,relative_ayah_index)
+    juzu = 0
+    Juzus[1..31].each do |j|
+      juzu += 1
+      if  j[0] == sura and j[1] == relative_ayah_index
+        return juzu
+      elsif j[0] > sura 
+        return juzu - 1
+      elsif j[0] == sura and j[1]> relative_ayah_index
+        return juzu - 1 
+      end
+    end
+   end 
+   
+  def self.sura_for_ayah(absolute_ayah_index)
+  	return nil if not valid_absolute_ayah(absolute_ayah_index)
+    surah = 0 
+    Suras.each do |s|
+      if !s.empty?
+        if s[1] + s[2] - 1 >= absolute_ayah_index
+          break
+        end
+      end
+      surah += 1 
+    end
+    return surah
+  end 
+  
+  def self.relative_for_ayah(absolute_ayah_index)
+    return nil if not valid_absolute_ayah(absolute_ayah_index)
+    surah = sura_for_ayah(absolute_ayah_index)
+    return absolute_ayah_index - Suras[surah][1]+1
+  end
+
+  def self.juzu_for_absolute_ayah_index(absolute_ayah_index)
+    juzu_for_ayah(sura_for_ayah(absolute_ayah_index),relative_for_ayah(absolute_ayah_index))
+  end
+
+  # an ayah is valid if the sura is between 1 and 114 and ayah is <= number of ayas in that sura
+  def self.valid_ayah(sura,ayah)
+    (1..114).include?(sura) and (1..Suras[sura][2]).include?(ayah) 
+  end
+
+  def self.valid_absolute_ayah(absolute_ayah_index)
+    (0..6235).include?(absolute_ayah_index)
+  end
+end

data/lib/rquran/rquran_mixin.rb

@@ -0,0 +1,46 @@
+module Rquran
+	module Mixin
+		module ClassMethods
+		  # enables an object to have a property that acts as an ayah reference with all releated methods. 
+			def has_ayah(*args)
+				args.each do |aya_var|
+					attr_accessor aya_var
+					define_method aya_var.to_s + "_ayah" do
+						val = send(aya_var) 
+						return nil if val.nil?
+						val.class == Array ? val[1] : (Rquran.relative_for_ayah(val)) 
+					end
+					define_method aya_var.to_s + "_sura" do
+						val = send(aya_var) 
+						return nil if val.nil?
+						val.class == Array ? val[0] : (Rquran.sura_for_ayah(val))
+					end
+					define_method aya_var.to_s + "_sura_name" do
+						val = send(aya_var)
+						return nil if val.nil?
+						val.class ==  Array ? Rquran.sura_name(val[0]) : Rquran.sura_name(send(aya_var.to_s+"_sura"))
+					end
+					define_method aya_var.to_s+"_valid?" do
+						val = send(aya_var)
+						return nil if val.nil?
+						Rquran.valid_ayah(send(aya_var.to_s+"_sura") , send(aya_var.to_s+"_ayah"))
+					end
+					define_method aya_var.to_s + "_juzu" do
+					 val = send(aya_var)
+					 return nil if val.nil?
+					 Rquran.juzu_for_ayah(send(aya_var.to_s+"_sura") , send(aya_var.to_s+"_ayah"))
+					end
+				end
+			end
+		end
+		
+		module InstanceMethods
+			
+		end
+		
+		def self.included(receiver)
+			receiver.extend         ClassMethods
+			receiver.send :include, InstanceMethods
+		end
+	end
+end

data/lib/rquran/version.rb

@@ -0,0 +1,4 @@
+module Rquran
+  VERSION = "1.0.0"
+end
+

data/rquran.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rquran/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rquran"
+  s.version     = Rquran::VERSION
+  s.authors     = ["Abdulaziz Alnutaifi"]
+  s.email       = ["abdulaziz.alnutaifi@me.com"]
+  s.homepage    = ""
+  s.summary     = %q{Gem for Quran related calculations, meta-data}
+  s.description = %q{Gem for quran related calculations, meta-data}
+
+  s.rubyforge_project = "rquran"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rquran
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Abdulaziz Alnutaifi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies: []
+description: Gem for quran related calculations, meta-data
+email:
+- abdulaziz.alnutaifi@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardoc/checksums
+- .yardoc/object_types
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
+- Gemfile
+- README.md
+- Rakefile
+- doc/QuranData.html
+- doc/Rquran.html
+- doc/Rquran/Mixin.html
+- doc/Rquran/Mixin/ClassMethods.html
+- doc/Rquran/Mixin/InstanceMethods.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/rquran.rb
+- lib/rquran/quran_data.rb
+- lib/rquran/rquran.rb
+- lib/rquran/rquran_mixin.rb
+- lib/rquran/version.rb
+- rquran.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rquran
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem for Quran related calculations, meta-data
+test_files: []
+has_rdoc: