Tree @debian/3.3.0-1 (Download .tar.gz)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | # Gemojione [![Build Status][travisUrl]][travisProject] [![Downloads][downs]][rubyUrl] [![Version][version]][rubyUrl] [![Dependencies][gemnasiumDeps]][gemnasiumProject] [![Coverage][coverage]][codeclimate] [![GPA][gpa]][codeClimate] A gem for EmojiOne This gem exposes the [emojione](http://emojione.com/) unicode/image assets and APIs for working with them. Easily lookup emoji name, unicode character, or image assets and convert emoji representations. ## Installation Add this line to your application's Gemfile: ```ruby gem 'gemojione' ``` And then execute: $ bundle Or install it yourself as: $ gem install gemojione Install emoji image library assets: $ rake gemojione:install_assets ==================================================================== = emoji image assets install = Target: /Users/user/src/rails-app/app/assets/images/emoji = Source: /Users/user/src/emoji/assets ==================================================================== - Creating /Users/user/src/rails-app/app/assets/images/emoji... - Installing assets... ## Usage You can use this gem to replace unicode emoji characters with img tags linking to the appropriate emoji image. Image Replacement APIs: ```ruby > Gemojione.replace_unicode_moji_with_images('I ❤ Emoji') => "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji" > Gemojione.replace_named_moji_with_images('I :heart: Emoji') => "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji" > Gemojione.image_url_for_unicode_moji('❤') => "http://localhost:3000/assets/emoji/2764.png" > Gemojione.image_url_for_name('heart') => "http://localhost:3000/assets/emoji/2764.png" > Gemojione.replace_ascii_moji_with_images("I <3 Emoji") => "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji" ``` Sprite Replacement APIs: ```ruby Gemojione.use_sprite=true > Gemojione.replace_unicode_moji_with_images("I ❤ Emoji") => "I <span class=\"emojione emojione-2764\" alt=\"❤\" title=\"❤\">❤</span> Emoji" > Gemojione.replace_named_moji_with_images("I :heart: Emoji") => "I <span class=\"emojione emojione-2764\" alt=\"❤\" title=\"❤\">❤</span> Emoji" > Gemojione.replace_ascii_moji_with_images("I <3 Emoji") => "I <span class=\"emojione emojione-2764\" alt=\"❤\" title=\"❤\">❤</span> Emoji" ``` Emoji Library Index APIs: ```ruby > index = Gemojione::Index.new > index.find_by_name('heart') => {"moji"=>"❤", "unicode"=>"2764", "unicode_alternates"=>["2764-FE0F"], "name"=>"heart", "shortname"=>":heart:", "category"=>"symbols", "aliases"=>[], "aliases_ascii"=>["<3"], "keywords"=>["like", "love", "red", "pink", "black", "heart", "love", "passion", "romance", "intense", "desire", "death", "evil", "cold", "valentines"], "description"=>"heavy black heart"} > index.find_by_moji('❤') => {"moji"=>"❤", "unicode"=>"2764", "unicode_alternates"=>["2764-FE0F"], "name"=>"heart", "shortname"=>":heart:", "category"=>"symbols", "aliases"=>[], "aliases_ascii"=>["<3"], "keywords"=>["like", "love", "red", "pink", "black", "heart", "love", "passion", "romance", "intense", "desire", "death", "evil", "cold", "valentines"], "description"=>"heavy black heart"} > index.find_by_keyword('teeth') => [{"unicode"=>"1F62C", "unicode_alternates"=>[], "name"=>"grimacing", "shortname"=>":grimacing:", "category"=>"people", "aliases"=>[], "aliases_ascii"=>[], "keywords"=>["face", "grimace", "teeth", "disapprove", "pain", "silly", "smiley", "emotion", "selfie"], "moji"=>"😬", "description"=>"grimacing face"}, {"unicode"=>"1F479", "unicode_alternates"=>[], "name"=>"japanese_ogre", "shortname"=>":japanese_ogre:", "category"=>"people", "aliases"=>[], "aliases_ascii"=>[], "keywords"=>["monster", "japanese", "oni", "demon", "troll", "ogre", "folklore", "devil", "mask", "theater", "horns", "teeth"], "moji"=>"👹", "description"=>"japanese ogre"}] > index.find_by_ascii(':)') => {"unicode"=>"1F604", "unicode_alternates"=>[], "name"=>"smile", "shortname"=>":smile:", "category"=>"people", "aliases"=>[], "aliases_ascii"=>[":)", ":-)", "=]", "=)", ":]"], "keywords"=>["face", "funny", "haha", "happy", "joy", "laugh", "smile", "smiley", "smiling", "emotion"], "moji"=>"😄","description"=>"smiling face with open mouth and smiling eyes"} ``` Default configuration integrates with Rails, but you can change it with an initializer: ```ruby # config/initializers/gemojione.rb Gemojione.asset_host = "emoji.cdn.com" Gemojione.asset_path = '/assets/emoji' Gemojione.default_size = '64px' Gemojione.use_svg = true Gemojione.use_sprite = true ``` You can also serve the assets directly from the gem in your rails app: ```ruby # config/application.rb config.assets.paths << Gemojione.images_path config.assets.precompile << "emoji/*.png" # or config.assets.precompile << "emoji/*.svg" #for spritesheets config.assets.paths << Gemojione.sprites_path config.assets.precompile << "emojione.sprites.css" config.assets.precompile << "emojione.sprites.png" ``` String Helper Methods: You can also ```ruby include 'gemojione/string_ext' ``` and call methods directly on your string to return the same results: ```ruby > 'I ❤ Emoji'.with_emoji_images => "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji" > 'I :heart: Emoji'.with_emoji_names => "I <img alt=\"❤\" class=\"emoji\" src=\"http://localhost:3000/assets/emoji/2764.png\"> Emoji" > 'heart'.image_url > '❤'.image_url => "http://localhost:3000/assets/emoji/2764.png" > 'heart'.emoji_data > '❤'.emoji_data => {"moji"=>"❤", "unicode"=>"2764", "unicode_alternates"=>["2764-FE0F"], "name"=>"heart", "shortname"=>":heart:", "category"=>"symbols", "aliases"=>[], "aliases_ascii"=>["<3"], "keywords"=>["like", "love", "red", "pink", "black", "heart", "love", "passion", "romance", "intense", "desire", "death", "evil", "cold", "valentines"], "description"=>"heavy black heart"} ``` ## HTML Safety and Performance This gem uses pure ruby code for compatibility with different Ruby virtual machines. However, there can be significant performance gains to escaping incoming HTML strings using optimized, native code in the `escape_utils` gem. The emoji gem will try to use `escape_utils` if it's available, but does not require it. [Benchmarks show a 10x-100x improvement](https://gist.github.com/wpeterson/c851be471bd91868716c) in HTML escaping performance, based on the size of the string being processed. To enable native HTML escaping, add this line to your application's Gemfile: ```ruby gem 'escape_utils' ``` ## Spritesheet scaling If you’re using spritesheets, customising `Gemojione.default_size` at `config/initializers/gemojione.rb` won’t work. Default size for sprite tag is 64px x 64px, but [`zoom`](http://caniuse.com/#feat=css-zoom) or [`transform: scale()`](http://caniuse.com/#feat=transforms2d) can be used for custom scaling. transform: scale() is more widely supported. ```css .emojione{ transform: scale(.5); margin: -15px; } ``` ## Projects using the gem * [Gitlab](https://github.com/gitlabhq/gitlabhq) * [Gollum](https://github.com/gollum/gollum) * [EpicBuzz](https://www.epicbuzz.net) If your application uses the gem, open a PR and show your project's :heart: for the gem so it gets listed here. ## Contributors: :heart: This gem is a former fork of the [emoji](https://github.com/wpeterson/emoji) gem that has been adapted for EmojiOne. * [@mikowitz](https://github.com/mikowitz): `String` ext helpers * [@semanticart](https://github.com/semanticart): Cleanup/Ruby 1.9.3 support * [@parndt](https://github.com/parndt): README doc fixes * [@neuegram](https://github.com/neuegram): XSS Security Audit * [@jonathanwiesel](https://github.com/jonathanwiesel): Emojione support * [@balasankarc](https://github.com/balasankarc): Asset executable bit cleaning. * [@tsigo](https://github.com/tsigo): Ability to serve assets directly from the gem in a rails app. * [@ZJvandeWeg](https://github.com/ZJvandeWeg): "Find by ASCII" feature. * [@kendrikat](https://github.com/kendrikat): Railtie dependecy checker, default size option support and new `replace_named_moji_with_images` feature. * [@gnclmorais](https://github.com/gnclmorais): Add `replace_named_moji_with_images ` missing ext helper. * [@naveed-ahmad](https://github.com/naveed-ahmad): ASCII replacement API and Spritesheet support. * [@Eric-Guo](https://github.com/Eric-Guo): Usage of `.ruby-version` instead of `.rvmrc`. * [@amyspark](https://github.com/amyspark): Add `find_by_shortname` * [@ryosuke-endo](https://github.com/ryosuke-endo): Access to emoji list and `find_by_category`. * [@connorshea](https://github.com/connorshea): Bugfixing. ## Contributing 1. Fork it 2. Bundle Install (`bundle install`) 3. Run the Tests (`rake test`) 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 ## Notes Run `rake resprite` to regenerate the spritesheets if you're adding new images [travisUrl]: https://travis-ci.org/jonathanwiesel/gemojione.svg?branch=master [travisProject]: https://travis-ci.org/jonathanwiesel/gemojione [downs]: https://img.shields.io/gem/dt/gemojione.svg [version]: https://img.shields.io/gem/v/gemojione.svg [rubyUrl]: https://rubygems.org/gems/gemojione [gemnasiumDeps]: https://img.shields.io/gemnasium/jonathanwiesel/gemojione.svg [gemnasiumProject]: https://gemnasium.com/jonathanwiesel/gemojione [coverage]: https://img.shields.io/codeclimate/coverage/github/jonathanwiesel/gemojione.svg [codeclimate]: https://codeclimate.com/github/jonathanwiesel/gemojione [gpa]: https://img.shields.io/codeclimate/github/jonathanwiesel/gemojione.svg |
Commit History @debian/3.3.0-1
0
»»
- upload to experimental Praveen Arimbrathodiyil 7 years ago
- make gem2deb >= 0.32 Praveen Arimbrathodiyil 7 years ago
- use --gem-install Pirate Praveen 7 years ago
- import 3.1.0 Pirate Praveen 7 years ago
- Merge tag 'upstream/3.1.0' Pirate Praveen 7 years ago
- Imported Upstream version 3.1.0 Pirate Praveen 7 years ago
- update changelog Pirate Praveen 7 years ago
- Merge tag 'upstream/2.6.1' Pirate Praveen 7 years ago
- Imported Upstream version 2.6.1 Pirate Praveen 7 years ago
- * Update debian/rules Sagar Ippalpalli 8 years ago
- * update rules to add assets folder Sagar Ippalpalli 8 years ago
- * add patch description Sagar Ippalpalli 8 years ago
- * update patch file Sagar Ippalpalli 8 years ago
- * update changelog Sagar Ippalpalli 8 years ago
- * added new release Sagar Ippalpalli 8 years ago
- Merge tag 'upstream/2.2.1' Sagar Ippalpalli 8 years ago
- Imported Upstream version 2.2.1 Sagar Ippalpalli 8 years ago
- Run wrap-and-sort on packaging files Cédric Boutillier 8 years ago
- Bump Standards-Version to 3.9.7 (no changes needed) Cédric Boutillier 8 years ago
- Use https:// in Vcs-* fields Cédric Boutillier 8 years ago
- Use https:// in Vcs-* fields Cédric Boutillier 8 years ago
- update changelog Praveen Arimbrathodiyil 8 years ago
- remove git usage from gemspec Praveen Arimbrathodiyil 8 years ago
- Make tests run Balasankar C 8 years ago
- Fix locales issue to run tests Balasankar C 8 years ago
- Install index.json and image files Balasankar C 8 years ago
- Tweak d/c* files Balasankar C 8 years ago
- Imported Debian patch 2.1.0-1 Balasankar C 8 years ago
- Imported Upstream version 2.1.0 Balasankar C 8 years ago
0
»»