How to include custom .rb script in Rails app

Question

Ok, I've got this Ruby script that is supposed to be included in many Rails apps. So I don't want to break it down to pieces and jam it into a particular app, but would rather keep it in 1 piece and have Rails app load it instead. The script would be required mostly from models, mailers and rarely controllers.

So if my script is tools.rb, where in my Rails file tree should I put it and how/where in my Rails app should I include it? Also the script comes with YAML file.

Its my second day learning Rails, so please bear with me.

lngs · Accepted Answer · 2014-11-18 17:05:34Z

7

You can keep all the extra stuff in either /app/modules or /lib. And i prefer lib. After putting in the lib folder, require it in any initializer (or create one)

require "./lib/tools" in /config/initializers/tools.rb

And tadaa !! You can use that corresponding class/module anywhere in the rails application !!

And all the YAML files should be put in /config/.

*** fix syntax in '/lib/tools'

edited Nov 18, 2014 at 17:05

lngs

6981 gold badge8 silver badges17 bronze badges

answered Feb 16, 2013 at 15:53

Ramandeep Singh

5,2833 gold badges31 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

hyperrjas · Accepted Answer · 2013-02-16 15:54:22Z

5

You can include your own .rb files on lib folder. You can include, modules, class...etc under your own rb files.

If you want autoload or autorequire your custom library code, you must open your config/application.rb and add the next line for example:

config.autoload_paths += %W(#{config.root}/extras #{config.root}/lib)

You can take a look to:

http://reefpoints.dockyard.com/ruby/2012/02/14/love-your-lib-directory.html

You yaml files should be inside /config/ folder.

Regards!

answered Feb 16, 2013 at 15:54

hyperrjas

10.8k25 gold badges103 silver badges200 bronze badges

Comments

Rahul Tapali · Accepted Answer · 2013-02-16 16:05:32Z

2

If you have any module or class defined in script and use that module or class in app you just put it in lib . It will be accessed anywhere in app. Load the file if you need to initialize something which needs your application. Unless needed don't load things. If you think it must be loaded before app starts. Then you can put into config/initializers

yml files can be loaded like below in some initializers file (may be in your tools.rb) :

     MY_TOOLS = YAML.load_file("#{RAILS_ROOT}/config/tools.yml")

Then you can use MY_TOOLS anywhere in app.

edited Feb 16, 2013 at 16:05

answered Feb 16, 2013 at 15:47

Rahul Tapali

10.2k7 gold badges33 silver badges45 bronze badges

4 Comments

if __name__ is None Over a year ago

Okay, I've put tools.rb in /lib, Yaml file in /config and restarted the server. But now when I try to create instance of class in tools.rb from Model, it goes: ModelName::ClassImTryingToCall not found. How do I make it so it gets to my class in tools.rb?

Rahul Tapali Over a year ago

You will have access to all model of your app in lib.. its not a problem.

if __name__ is None Over a year ago

Ok I figured out what was wrong. I guess its a convention. It wanted to have a class/module with same name as file. So in tools.rb had to make class Tools, now it works.

Rahul Tapali Over a year ago

Ya u should have same filename as class name. Thats how rails find classes. If u don't specify same filename as class name rails can't find class.

Collectives™ on Stack Overflow

How to include custom .rb script in Rails app

3 Answers 3

Comments

Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related