Code Monkey home page Code Monkey logo

acts-as-metadata's Introduction

ActsAsMetadata

Dynamicly add unlimited number of indexed, searchable, validatable, strongly typed fields to your ActiveRecord models.

Installation

Add this line to your application's Gemfile:

gem 'acts_as_metadata'

And then execute:

$ bundle

Or install it manually:

$ gem install acts_as_metadata

Usage

Generate migration that creates metadata tables:

$ rails g metadata:migration

Add acts_as_metadata to your model:

class MyModel < ActiveRecord::Base
  acts_as_metadata
end

and create metadata_cache column to speed up metadata extraction:

rails g migration AddMetadataCacheToMyModels metadata_cache:text

Create metadata types in your database:

mt = MetadataType.create! :tag => :sample, :name => "Sample", :datatype => :string

Its ready to use:

m = MyModel.new
m.m_sample = 'some string'
m.save!

Add some validations or default value if you need:

mt.default   = 'some default string' 
mt.mandatory = true                   # presence validation
mt.regexp    = "[a-z]*"               # regexp validation
mt.values    = ['aaa', 'bbb', 'ccc']  # inclusion validation
mt.save!

There are more usage examples in spec directory.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

acts-as-metadata's People

Contributors

gropher avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

acts-as-metadata's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.